diff --git a/README.md b/README.md index f31c770..68e9703 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,7 @@ Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera * Function: `$_(selector).module.function(params);` -## Official Modules: ## -### Global: Core functions ### +### Core Methods ### **properties:** @@ -48,126 +47,12 @@ Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera * type: For getting the type of a variable $_.type(var); - -### Ajax: simple, jQuery-like ajax functions ### -functions: - -* Get: - - $_.get(url, data_object, callback); +Have a look at the /docs folder included with the library for documentation on the included modules. The development version of the documentation is avaliable at -* Post: +[[http://dev.timshomepage.net/kis-js/docs/]](http://dev.timshomepage.net/kis-js/docs/) - $_.post(url, data_object, callback); - - -### Store: localstorage wrapper with automatic data serialization ### - -**functions:** - -* Get: - - $_.store.get(key); - -* Set - - $_.store.set(key, value); - -* Remove - - $_.store.remove(key); - -* getALL: Retreives all localstorage data in raw form - - $_.store.getAll(); - - -### Event: wrapper for applying events to DOM objects ### - -**functions:** - -* Add: - - $_(selector).event.add(event, callback); - -* Remove - - $_(selector).event.remove(event, callback); - -* Live: (for elements that are dynamically added and removed) - - $_.event.live(selector, event, callback); - -* Delegate: - - $_(selector).delegate(target, event, callback); - -### DOM: Dom manipulation module ### - -**functions:** - -* addClass: - - $_(selector).dom.addClass(className); - -* RemoveClass: - - $_(selector).dom.removeClass(className); - -* show: For setting dom elements as visible. Type defaults as "block", can be set with optional second parameter. - - $_(selector).dom.show([type]); - -* hide: Hides the elements matching the selector - - $_(selector).dom.hide(); - -* attr: Gets, sets, or removes an attribute from a selector. - - 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 - - Set: $_(selector).dom.text(text); - Get: $_(selector).dom.text(); - -* css: Sets css styles on the selected element(s) - - Set: $_(selector).dom.css(property, value); - Get: $_(selector).dom.css(property); - -* html: Sets or gets html inside the selected element - - Set: $_(selector).dom.html(html_string); - Get: $_(selector).dom.html(); - -### Util: Array and string manipulation functions ### - -**functions:** - -* object_keys: Gets the name of the properties of an object - - $_.util.object_keys(object); - -* object_values: Gets the values of the top-level members of an object - - $_.util.object_values(object); - -* object_merge: Merges two objects' keys and values - - $_.util.object_merge(object1, object2); - -* array_combine: Creates an object with the keys of the first array, and the values of the second - - $_.util.array_combine(keys, values); - -* str_trans: Similar to the PHP function strtr, replaces string pairs in a GREEDY fashion - - $_.util.str_trans(string, from, to); OR $_.util.str_trans(string, replace_pairs_object); diff --git a/docs/files.html b/docs/files.html index d5e631b..5331e92 100644 --- a/docs/files.html +++ b/docs/files.html @@ -1,5 +1,6 @@ - - + +
@@ -29,23 +30,23 @@- - | -- void - | -
- - | -- void - | -
- - | -- void - | -
- - | -- void - | -
- - | -- void - | -
- - | -- void - | -
- - | -- void - | -
- + + | ++ function | - void + callback | - string + object |
context
@@ -452,20 +453,6 @@ Simple DOM selector function
- Returns:
-
Returns:
-
Returns:
-
Returns:
-
+ ©2011
diff --git a/docs/symbols/$_.store.html b/docs/symbols/$_.store.html
index 15bc7b3..fd79a07 100644
--- a/docs/symbols/$_.store.html
+++ b/docs/symbols/$_.store.html
@@ -1,5 +1,6 @@
-
-
+
+
@@ -32,23 +33,23 @@
+ Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) +
- $(string, object) ext(string, object) each(function) type(mixed) get(string, object, function) post(string, object, function)
-
+
-
+ add(string, function) remove(string, string) live(string, string, function) delegate(string, string, function)
+
- object_keys(object) object_values(object) array_combine(array/object, array/object) object_merge(object) str_trans(string, mixed, string) object_keys(object) object_values(object) array_combine(array/object, array/object) object_merge(object) str_trans(string, mixed, string)
@@ -65,7 +66,7 @@
+
+
- Kis JS Documentation
+ Kis JS Docs
@@ -125,6 +126,14 @@
Removes the specified item from storage
+
+ ©2011
+ Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 03 2011 16:01:49 GMT-0400 (EDT) +
- $(string, object) ext(string, object) each(function) type(mixed) get(string, object, function) post(string, object, function)
-
+
-
+ add(string, function) remove(string, string) live(string, string, function) delegate(string, string, function)
+
- object_keys(object) object_values(object) array_combine(array/object, array/object) object_merge(object) str_trans(string, mixed, string) object_keys(object) object_values(object) array_combine(array/object, array/object) object_merge(object) str_trans(string, mixed, string) |
- + from (string)/replace pairs (object) | @@ -468,7 +469,7 @@ from => to replacements as key/value pairs string?, Default:- to + | @@ -504,6 +505,10 @@ from => to replacements as key/value pairs