chepollo v1.0.8
Che Pollo!
ChePollo is an ultra-simple framework for common javascript client tasks, such as:
- Manipulating the DOM
- Debouncing functions
- Saving data on localStorage (falling back to cookies)
ChePollo is:
- super-light (<4kb)
- written in pure Vanilla javascript using ES6 syntax.
- transpiled to ES5 using babel and gulp
- packed in a CommonJS module or available in global scope (window.oo)
- compatible with IE > 7 (it has polyfill included)
Install
$ npm install chepollo
Usage
oo.ready(function(){
var foo = oo.getById('foo');
oo.addClass(foo, 'pollastro');
oo.addData(foo, 'somekey', 'somedata');
oo.getData(foo, 'somekey'); // "somedata"
oo.debounce(function(){
foo.removeClass(foo, 'pollastro');
}, 1000)();
});
API reference
chepollo~oo
Class oo.
Kind: inner class of chepollo
- ~oo
- .ready(_callback)
- .getAll(_selector) ⇒ NodeList
- .getOne(_selector) ⇒ Element
- .getById(_id) ⇒ Element
- .fadeIn(_el, _duration)
- .fadeOut(_el, _duration)
- .addClass(_el, _classes)
- .removeClass(_el, _classes)
- .hasClass(_el, _class) ⇒ boolean
- .toggleClass(_el, _class)
- .addData(_el, _key, _data)
- .getData(_el, _key) ⇒ string | undefined
- .storageGet(_key)
- .storageSet(_key, _data)
- .storageRemove(_key)
- .storageClear()
- .cookieSet(cname, cvalue, exdays)
- .cookieGet(cname) ⇒ *
- .debounce(func, wait, immediate) ⇒ function
oo.ready(_callback)
on DOM ready
Kind: instance method of oo
Param | Type |
---|---|
_callback | function |
oo.getAll(_selector) ⇒ NodeList
return an array of DOM nodes using querySelectorAll()
Kind: instance method of oo
Param | Type |
---|---|
_selector | string |
oo.getOne(_selector) ⇒ Element
return a dom Element using querySelector()
Kind: instance method of oo
Param |
---|
_selector |
oo.getById(_id) ⇒ Element
return a DOM node using getElementById
Kind: instance method of oo
Param | Type |
---|---|
_id | string |
oo.fadeIn(_el, _duration)
fadeIn a DOM element
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_duration | int |
oo.fadeOut(_el, _duration)
fadeOut a DOM element
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_duration | int |
oo.addClass(_el, _classes)
add a class to a DOM element
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_classes | string |
oo.removeClass(_el, _classes)
remove a class from a DOM element
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_classes | string |
oo.hasClass(_el, _class) ⇒ boolean
checks if the given DOM element has a class
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_class | string |
oo.toggleClass(_el, _class)
toggle a DOM element class
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_class | string |
oo.addData(_el, _key, _data)
add content to a DOM element dataList
Kind: instance method of oo
Param | Type |
---|---|
_el | Element |
_key | string |
_data | string |
oo.getData(_el, _key) ⇒ string | undefined
return the content of the given dataList key
Kind: instance method of oo
Param |
---|
_el |
_key |
oo.storageGet(_key)
get data from localStorage (with cookie fallback)
Kind: instance method of oo
Param |
---|
_key |
oo.storageSet(_key, _data)
set data in localStorage (with cookie fallback)
Kind: instance method of oo
Param |
---|
_key |
_data |
oo.storageRemove(_key)
removes a key from localStorage (with cookie fallback)
Kind: instance method of oo
Param |
---|
_key |
oo.storageClear()
clear localStorage (with cookie fallback)
Kind: instance method of oo
oo.cookieSet(cname, cvalue, exdays)
set a cookie
Kind: instance method of oo
Param |
---|
cname |
cvalue |
exdays |
oo.cookieGet(cname) ⇒ *
get a cookie
Kind: instance method of oo
Param |
---|
cname |
oo.debounce(func, wait, immediate) ⇒ function
debounce a function
Kind: instance method of oo
Param | Type |
---|---|
func | function |
wait | int |
immediate | boolean |