CODEWITHSUNDEEP
javascriptjqueryjquery-events
T Nguyen
T Nguyen

Reputation: 3415

Is it safe to call $(document).ready() from inside a function?

If I use the $(document).ready() handler from within a function, will it still guarantee that the code inside it will only be run if the document is ready, even if the document ready event has occurred well in the past?

Upvotes: 5

Views: 5259

Answers (3)

Rahman Kalfane
Rahman Kalfane

Reputation: 1717

Yes.

From the jQuery ready function source.

// Catch cases where $(document).ready() is called after the
// browser event has already occurred.
if ( document.readyState === "complete" ) {
    // Handle it asynchronously to allow scripts the opportunity to delay ready
    return setTimeout( jQuery.ready, 1 );
}

Upvotes: 14

Jeremy Banks - Vive le Canada
Jeremy Banks - Vive le Canada

Reputation: 129745

Yes, that is safe. jQuery has several ways to set handlers like this, and the only "unsafe" one is $(document).bind("ready", handler). From the jQuery docs:

All three of the following syntaxes are equivalent:

  1. $(document).ready(handler)
  2. $().ready(handler) (this is not recommended)
  3. $(handler)

There is also $(document).bind("ready", handler). This behaves similarly to the ready method but with one exception: If the ready event has already fired and you try to .bind("ready") the bound handler will not be executed. Ready handlers bound this way are executed after any bound by the other three methods above.

Upvotes: 4

mnsr
mnsr

Reputation: 12437

Yes. You can put it inside a function, and it'll fire whenever you call that function.

Upvotes: 1

Related Questions