kis-js/README.md

107 lines
2.2 KiB
Markdown
Raw Normal View History

# Keep It Simple JS Library #
A Minimal, Modular Javascript library for Modern browsers.
Aims to be fast, small, and easily split into individual modules.
Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera
## Basic Use: ##
* Selector: `var x = $(selector);`
* Function: `$_.module.function(params);`
## Modules: ##
**Ajax**: simple, jQuery-like ajax functions
functions:
* Get:
Use:
$_.get(url, data_object, callback);
* Post:
Use:
$_.post(url, data_object, callback);
**QS**: querystring parsing and serialization for hashbang strings, and pushState urls
functions:
* Parse:
2011-06-14 12:54:47 -04:00
Use:
$_.qs.parse(hb);
* Set: This function will set the hash url if browser doesn't have history.pushState
2011-06-14 12:54:47 -04:00
Use:
$_.qs.set(key, value);
* Get: Retrieves the value of the key in the url string
2011-06-14 12:54:47 -04:00
Use:
$_.qs.get(key);
**Store**: localstorage wrapper with automatic data serialization
functions:
* Get:
Use:
$_.store.get(key);
* Set
Use:
$_.store.set(key, value);
* getALL: Retreives all localstorage data in raw form
Use:
$_.store.getAll();
**Event**: wrapper for applying events to DOM objects
2011-06-21 10:43:31 -04:00
functions:
*Add:
Use:
$_.event.add(selector, event, callback);
*Remove
Use:
$_.event.remove(selector, event, callback);
2011-06-21 10:43:31 -04:00
**DOM**: Dom manipulation module
function:
*addClass:
Use:
$_.dom.addClass(selector, className);
*RemoveClass:
Use:
$_.dom.removeClass(selector, className);
*each: For applying changes to every item matched by a selector
Use:
$_.dom.each(selector, callback);
*show: For setting dom elements as visible. Type defaults as "block", can be set with optional second parameter.
Use:
$_.dom.show(selector, [type]);
*hide: Hides the elements matching the selector
Use:
$_.dom.hide(selector);
#attr: Gets, sets, or removes an attribute from a selector.
Use:
Set: $_.dom.attr(selector, attributeName, attributeValue);
Get: $_.dom.attr(selector, attributeName);
Remove: $_.dom.attr(selector, attributeName, null);