README

elo

elo is a lo-fi JavaScript events API that runs cross-browser and gzips <3k. It's an events library for minimalists. It works as a standalone library or can integrate into a host such as ender.

elo()

The elo() function is a simple OO wrapper that works like the jQuery function.

elo(element)       // wrap a DOM element (all browsers)
elo(elementArray)  // wrap NodeList or array of elements  (all browsers)
elo(tagName)       // wrap element(s) matched by tag name (all browsers)
elo(selector)      // wrap element(s) matched by a selector string (uses querySelectorAll)
elo(function($){   }); // ready shortcut (receives elo as its 1st arg, this === document)

domReady

Call a function when the DOM is ready:

elo.domReady(function($){ 
    /* ($ === elo) and (this === document) in here */ 
});

elo(document).ready(function($){
    /* ($ === elo) and (this === document) in here */ 
});

top-level

// the top-level versions of these operate on a single element:

$.on(elem, eventName, handler)
$.off(elem, eventName, handler)
$.one(elem, eventName, handler)
$.trigger(elem, eventName [, extraParams])
$.data(elem, [, key , value])
$.removeData(elem, [, keys])

$.cleanData(obj)
$.each(obj, callback [, thisArg])
$.hasEvent(eventName [, tagNameOrElement])
$.applyAll(stack [, thisArg, argsArray])
$.mixin(supplier [, force])
$.mixinEvent(eventShortcutNamesSSV)
elo.noConflict(opt_callback)
elo.bridge(receiver [, force])

effins

// the effin versions opererate on all the elements in a matched set:

$(elems).on(eventName, handler)
$(elems).off(eventName, handler)
$(elems).one(eventName, handler)
$(elems).trigger(eventName [, extraParamsArray])
$(elems).data(key [, value])

$(elems).each(callback [, thisArg])
$.fn.mixin(supplier [, force])

I'm still working on these docs, but the source is already documented, and you can see all the methods if you do:

console.log(elo.mixin.call({}, elo));

Compatibility

Supports all major browsers. Tested in: Chrome / FF3+ / Opera / IE7+ / Safari. (If you do find a compatibility issue please report it here.)

License

elo is available under the MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!