Readme Formatting
This commit is contained in:
parent
da22f46b89
commit
c1528a0b8b
140
README.md
140
README.md
|
|
@ -16,7 +16,7 @@ Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera
|
|||
* Function: `$_(selector).module.function(params);`
|
||||
|
||||
## Official Modules: ##
|
||||
### Global ###: Core functions
|
||||
### Global: Core functions ###
|
||||
|
||||
properties:
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ functions:
|
|||
Adds 'zip' function to $_.
|
||||
|
||||
|
||||
### Ajax ###: simple, jQuery-like ajax functions
|
||||
### Ajax: simple, jQuery-like ajax functions ###
|
||||
|
||||
functions:
|
||||
|
||||
|
|
@ -51,86 +51,86 @@ functions:
|
|||
Use:
|
||||
$_.post(url, data_object, callback);
|
||||
|
||||
### QS ###: querystring parsing and serialization for hashbang strings, and pushState urls
|
||||
### QS: querystring parsing and serialization for hashbang strings, and pushState urls ###
|
||||
|
||||
functions:
|
||||
**functions:**
|
||||
|
||||
* Parse:
|
||||
Use:
|
||||
$_.qs.parse(hb);
|
||||
|
||||
* Set: This function will set the hash url if browser doesn't have history.pushState
|
||||
Use:
|
||||
$_.qs.set(key, value);
|
||||
|
||||
* Get: Retrieves the value of the key in the url string
|
||||
Use:
|
||||
$_.qs.get(key);
|
||||
* Parse:
|
||||
Use:
|
||||
$_.qs.parse(hb);
|
||||
|
||||
* Set: This function will set the hash url if browser doesn't have history.pushState
|
||||
Use:
|
||||
$_.qs.set(key, value);
|
||||
|
||||
* Get: Retrieves the value of the key in the url string
|
||||
Use:
|
||||
$_.qs.get(key);
|
||||
|
||||
### Store ###: localstorage wrapper with automatic data serialization
|
||||
### Store: localstorage wrapper with automatic data serialization ###
|
||||
|
||||
functions:
|
||||
**functions:**
|
||||
|
||||
* Get:
|
||||
Use:
|
||||
$_.store.get(key);
|
||||
|
||||
* Set
|
||||
Use:
|
||||
$_.store.set(key, value);
|
||||
* Get:
|
||||
Use:
|
||||
$_.store.get(key);
|
||||
|
||||
* Set
|
||||
Use:
|
||||
$_.store.set(key, value);
|
||||
|
||||
* getALL: Retreives all localstorage data in raw form
|
||||
Use:
|
||||
$_.store.getAll();
|
||||
|
||||
* getALL: Retreives all localstorage data in raw form
|
||||
Use:
|
||||
$_.store.getAll();
|
||||
|
||||
|
||||
### Event ###: wrapper for applying events to DOM objects
|
||||
### Event: wrapper for applying events to DOM objects ###
|
||||
|
||||
functions:
|
||||
**functions:**
|
||||
|
||||
*Add:
|
||||
Use:
|
||||
$_(selector).event.add(event, callback);
|
||||
|
||||
*Remove
|
||||
Use:
|
||||
$_(selector).event.remove(event, callback);
|
||||
*Add:
|
||||
Use:
|
||||
$_(selector).event.add(event, callback);
|
||||
|
||||
*Remove
|
||||
Use:
|
||||
$_(selector).event.remove(event, callback);
|
||||
|
||||
### DOM ###: Dom manipulation module
|
||||
### DOM: Dom manipulation module ###
|
||||
|
||||
functions:
|
||||
**functions:**
|
||||
|
||||
*addClass:
|
||||
Use:
|
||||
$_(selector).dom.addClass(className);
|
||||
|
||||
*RemoveClass:
|
||||
Use:
|
||||
$_(selector).dom.removeClass(className);
|
||||
|
||||
*show: For setting dom elements as visible. Type defaults as "block", can be set with optional second parameter.
|
||||
Use:
|
||||
$_(selector).dom.show([type]);
|
||||
|
||||
*hide: Hides the elements matching the selector
|
||||
Use:
|
||||
$_(selector).dom.hide();
|
||||
|
||||
*attr: Gets, sets, or removes an attribute from a selector.
|
||||
Use:
|
||||
Set: $_(selector).dom.attr(attributeName, attributeValue);
|
||||
Get: $_(selector).dom.attr(attributeName);
|
||||
Remove: $_(selector).dom.attr(attributeName, null);
|
||||
|
||||
*text: Gets or sets the text in between an element's tags
|
||||
Use:
|
||||
Set: $_(selector).dom.text(text);
|
||||
Get: $_(selector).dom.text();
|
||||
|
||||
*css: Sets css styles on the selected element(s)
|
||||
Use:
|
||||
Set: $_(selector).dom.css(property, value);
|
||||
Get: $_(selector).dom.css(property);
|
||||
*addClass:
|
||||
Use:
|
||||
$_(selector).dom.addClass(className);
|
||||
|
||||
*RemoveClass:
|
||||
Use:
|
||||
$_(selector).dom.removeClass(className);
|
||||
|
||||
*show: For setting dom elements as visible. Type defaults as "block", can be set with optional second parameter.
|
||||
Use:
|
||||
$_(selector).dom.show([type]);
|
||||
|
||||
*hide: Hides the elements matching the selector
|
||||
Use:
|
||||
$_(selector).dom.hide();
|
||||
|
||||
*attr: Gets, sets, or removes an attribute from a selector.
|
||||
Use:
|
||||
Set: $_(selector).dom.attr(attributeName, attributeValue);
|
||||
Get: $_(selector).dom.attr(attributeName);
|
||||
Remove: $_(selector).dom.attr(attributeName, null);
|
||||
|
||||
*text: Gets or sets the text in between an element's tags
|
||||
Use:
|
||||
Set: $_(selector).dom.text(text);
|
||||
Get: $_(selector).dom.text();
|
||||
|
||||
*css: Sets css styles on the selected element(s)
|
||||
Use:
|
||||
Set: $_(selector).dom.css(property, value);
|
||||
Get: $_(selector).dom.css(property);
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue