npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

youreadydom

v1.1.0

Published

A helper function for running code when the Document Object Model (DOM) is ready

Downloads

2

Readme

Table of Content

Library

youreadydom is a tiny, fully tested javascript library, written in ES6. It provides the same functionality as jQuery .ready() method without jQuery's overhead. Unlike jQuery, youreadydom is promise based—it's modern 😎. Check out the examples below.

You can add this to your list of reasons for why you might not need jquery anymore.

For those unfamiliar with jQuery .ready() method, it provides a way to run javascript code as soon as the Document Object Model (DOM) has finished loading.

'DOMContentLoaded'

Most browsers provide the 'DOMContentLoaded' event which provides similar functionality but differs in that it does not execute any listener which is added after the event is fired. Internally this library adds a single 'DOMContentLoaded' event listener only if DOM content has not already loaded. The listener is removed once the event is fired and all handlers are executed in the order they are added.

/** Comparison */
setTimeout(() => {
  document.addEventListener('DOMContentLoaded', () => {
    /** 'DOMContentLoaded' event has already fired so code doesn't run */
    alert('I will not run 😩')
  })

  domReady(() => {
    /** youreadydom works */
    alert('I will run 😊')
  })
}, 0)

window.onload

The 'load' event on window is fired when all resources on the page have finished loading. This includes images.

Browser Support

| Chrome | Safari | IE* / Edge | Firefox | Opera | | ------ | ------ | ---------- | ------- | ----- | | Yes | Yes | 9+ | Yes | Yes |

Note: Internet Explorer is supported as long as Promise is polyfilled. Check out polyfill.io for automatic browser polyfills!

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies

Using npm

> npm install --save youreadydom

Using yarn

> yarn add youreadydom

Using CDN (Not recommended)

<!-- Exposes `domReady` global function -->
<script src="https://unpkg.com/[email protected]/dist/youreadydom.min.js"></script>

Examples

Callback

Lib example using Javascript callbacks

'use strict'

var domReady = require('youreadydom')
var $ = document.querySelector.bind(document)


/** Oldschool 👍 */
domReady(function something() {
  var foo = $('#foo')
  var bar = $('#bar')

  /** Do something ... */
})

Promise

Lib example using Javascript Promises

import React from 'react'
import ReactDOM from 'react-dom'
import whenDOMisReady from 'youreadydom'

import $ from './dom'
import App from './App'


const renderApp = () => ReactDOM.render(<App />, $('#root'))

/** Enjoy a promise 😃 */
whenDOMisReady().then(renderApp)

Async Function

Lib example using Javascript async functions

import domToBeReady from 'youreadydom'

import $ from './dom'
import fetchFoo from './foo.service'


/** Just `await` it 😍 */
;(async function main() {
  const data = await fetchFoo()

  await domToBeReady()

  const foo = $('#foo')
  foo.textContent = data
})()

Contributors

Tahseen Malik

License

MIT