2014-09-05 11:57:18 -04:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Index< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Index< / h1 >
< h3 > < / h3 >
2014-09-17 09:31:12 -04:00
< section >
< article > < h1 > Keep It Simple JS Library< / h1 > < p > A Minimal, Modular Javascript library for Modern browsers.< / p >
< p > Aims to be fast, small, and easily split into individual modules.< / p >
< p > You can create your own library by adding and removing modules from the
src directory, and running the " combine.php" script. This will output a
" kis-custom.js" file. (Be careful, as the script will overwrite any " kis-custom.js"
file that already exists).< / p >
< p > Browser support: IE10+, Latest versions of Firefox, Chrome, Safari, Opera< / p >
< h2 > Basic Use:< / h2 > < ul >
< li > Function: < code > $_(selector).module.function(params);< / code > < / li >
< / ul >
< h3 > Core Methods< / h3 > < p > < strong > properties:< / strong > < / p >
< ul >
< li > el: The html object returned by the selector function.< / li >
< / ul >
< p > < strong > functions:< / strong > < / p >
< ul >
< li > < p > each: For applying changes to every item matched by a selector< / p >
< p > $_(selector).each(callback);< / p >
< p > Example :< / p >
< pre class = "prettyprint source" > < code > $_(" .foo" ).each(function(e){
$_(e).dom.text(value);
}):< / code > < / pre > < / li >
< li > < p > ext: For extending the library, adds this.el to the object or function supplied< / p >
< p > $_.ext(" name" , functionOrObject);< / p >
< p > Example:< / p >
< pre class = "prettyprint source" > < code > $_.ext(" zip" , function(){ ... }); // Adds 'zip' function to $_.< / code > < / pre > < / li >
< li > < p > type: For getting the type of a variable< / p >
< pre class = "prettyprint source" > < code > $_.type(var);< / code > < / pre > < / li >
< / ul >
< p > Have a look at the right sidebar of the docs included with the library for documentation on the included modules. The development version of the documentation is avaliable at< / p >
< p > < a href = "http://github.timshomepage.net/kis-js/docs/" > http://github.timshomepage.net/kis-js/docs/< / a > < / p >
< h4 > Lite Versions< / h4 > < p > There are two lite versions:< / p >
< pre class = "prettyprint source" > < code > 1. Lite - Includes only the ajax and events modules
2. Lite-dom - Includes ajax, events, and dom modules< / code > < / pre > < / article >
< / section >
2014-09-05 11:57:18 -04:00
< / div >
< nav >
2014-09-12 16:14:12 -04:00
< h2 > < a href = "index.html" > Index< / a > < / h2 > < h3 > Namespaces< / h3 > < ul > < li > < a href = "$_.html" > $_< / a > < / li > < li > < a href = "$_.dom.html" > dom< / a > < / li > < li > < a href = "$_.event.html" > event< / a > < / li > < li > < a href = "$_.store.html" > store< / a > < / li > < / ul >
2014-09-05 11:57:18 -04:00
< / nav >
< br clear = "both" >
< footer >
2014-09-17 09:31:12 -04:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-alpha9< / a > on Tue Sep 16 2014 16:57:40 GMT-0400 (EDT)
2014-09-05 11:57:18 -04:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
