oi
v0.9.5
Published
cross-browser domReady module
Downloads
26
Readme
oi
cross-browser standalone DOM ready method:
oi.domReady(function (oi) {
// This function fires when the DOM is ready.
// `this === document` in here
});
Note that oi.domReady
and oi.fn.ready
are identical. (The latter is provided for purely for integration purposes.)
oi also provides two simple cross-browser event methods:
oi.addEvent(elem, type, handler);
oi.removeEvent(elem, type, handler);
integration
Use the oi.bridge(receiver)
to integrate oi
into a receiver (or host). Integrated methods include the top-level .domReady
/.addEvent
/.removeEvent
methods. and if the receiver
has an .fn
object, it will also receive .fn.ready
:
oi.bridge(receiver) // integrate `oi`'s public methods into `receiver` (won't overwrite existing props)
oi.bridge(receiver, true) // integrate `oi`'s public methods into `receiver` (overwrites existing props)
The default behavior of the oi.bridge()
makes it so that the receiver
becomes the first arg passed to fns, like so:
receiver.domReady(function (receiver) {
// This function fires when the DOM is ready.
// `this === document` in here
});
The .domReady
(and .fn.ready
) methods both contain both a .remix()
method that can be used for freeform integration. Use this if you want to create a new version of the ready function which sends multiple custom args. The .remix()
method returns a new version of itself:
var customReadyMethod = oi.domReady.remix(customArg0, customArg1 /*, ...*/);
See advanced #integration notes in the source.