https://github.com/ryanve/oi

cross-browser DOM ready module
https://github.com/ryanve/oi

Last synced: about 1 month ago
JSON representation

cross-browser DOM ready module

• Host: GitHub
• URL: https://github.com/ryanve/oi
• Owner: ryanve
• Created: 2012-09-13T10:56:01.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-10-31T09:08:08.000Z (about 11 years ago)
• Last Synced: 2024-09-15T22:07:37.941Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/oi
• Size: 254 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [oi](../../)

#### cross-browser DOM ready module

```sh

$ npm install oi

```

### Usage

Fire a function when the DOM is ready:

```js

oi.domReady(function (oi) {

	// `this === document` in here

});

```

Simple cross-browser event methods:

```js

oi.addEvent(elem, eventName, handler);

oi.removeEvent(elem, eventName, handler);

```

### Integration

**oi** has a special method called `.bridge()` designed for integration. Integrated methods include the top-level `.domReady`/`.addEvent`/`.removeEvent` methods. If the `receiver` has an `.fn` object, it will also receive `.fn.ready`. Note that `oi.domReady` and `oi.fn.ready` are identical. The latter is provided purely for integration purposes.

```js

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:

```js

receiver.domReady(function (receiver) {

	// `this === document` in here

});

```

jQuery-compatible receivers also get `.fn.ready`:

```js

receiver(document).ready(function (receiver) {

	// `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:

```js

receiver.domReady = oi.domReady.remix(customArg0, customArg1 /*, ...*/);

```

See advanced [#integration notes in the source](oi.js).

## [MIT License](http://opensource.org/licenses/MIT)

Copyright (C) 2012 by [Ryan Van Etten](https://github.com/ryanve)