diff options
| author | Derek Jones <derek.jones@ellislab.com> | 2011-01-28 21:06:58 +0100 |
|---|---|---|
| committer | Derek Jones <derek.jones@ellislab.com> | 2011-01-28 21:06:58 +0100 |
| commit | 9d3ad267e8e8f2972ceea05c4281b0234ed3efb4 (patch) | |
| tree | ef6c3c43151996834fbc1e5d6f19b1f775e18ce2 /user_guide | |
| parent | d709c394bbc918283e09f501363559b665fa2a24 (diff) | |
some cleanup for the javascript class docs
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/libraries/javascript.html | 153 | ||||
| -rw-r--r-- | user_guide/libraries/jquery.html | 236 | ||||
| -rw-r--r-- | user_guide/nav/nav.js | 1 | ||||
| -rw-r--r-- | user_guide/toc.html | 1 |
4 files changed, 149 insertions, 242 deletions
diff --git a/user_guide/libraries/javascript.html b/user_guide/libraries/javascript.html index 864efc82d..55ad18907 100644 --- a/user_guide/libraries/javascript.html +++ b/user_guide/libraries/javascript.html @@ -58,9 +58,9 @@ Input Class <p class="important"><strong>Note:</strong> This driver is experimental. Its feature set and implementation may change in future releases.</p><br> <h1>Javascript Class</h1> -<p>Rewrite this paragraph: <a href="http://jquery.com/">jQuery</a> is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. CodeIgniter provides a library to help you with certain common functions that you may want to use within jQuery. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.</p> +<p>CodeIgniter provides a library to help you with certain common functions that you may want to use with Javascript. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.</p> <h2>Initializing the Class</h2> -<p>To initialize the jQuery class manually in your controller constructor, use the <dfn>$this->load->library</dfn> function. Currently, the only available library is jQuery, which will automatically be loaded like this:</p> +<p>To initialize the Javascript class manually in your controller constructor, use the <dfn>$this->load->library</dfn> function. Currently, the only available library is jQuery, which will automatically be loaded like this:</p> <code>$this->load->library('javascript');</code> @@ -73,20 +73,161 @@ Input Class <p>Once loaded, the jQuery library object will be available using: <dfn>$this->javascript</dfn></p> <h2>Setup and Configuration</h2> <h3>Set these variables in your view</h3> -<p>As a javascript library, your files must be available to your application. For your convenience, the needed files to run this library are available for <a href="http://codeigniter.com/downloads/">download</a> from our site.</p> -<p>As javascript is a client side language, the library must be able to write content into your final output. This generally means a view. You'll need to include the following variables in the <head> sections of your output.</p> +<p>As a Javascript library, your files must be available to your application.</p> +<p>As Javascript is a client side language, the library must be able to write content into your final output. This generally means a view. You'll need to include the following variables in the <head> sections of your output.</p> <p><code><?php echo $library_src;?><br /> <?php echo $script_head;?> </code></p> <p>$library_src, is where the actual library file will be loaded, as well as any subsequent plugin script calls; $script_head is where specific events, functions and other commands will be rendered.</p> <h3>Set the path to the librarys with config items</h3> -<p>There are some configuration items in javascript library. These can either be set in application/config.php, within its own confg/javascript.php file, or within any controller usings the set_item() function. </p> +<p>There are some configuration items in Javascript library. These can either be set in application/config.php, within its own config/javascript.php file, or within any controller usings the set_item() function. </p> <p>An image to be used as an "ajax loader", or progress indicator. Without one, the simple text message of "loading" will appear when Ajax calls need to be made.</p> <p><code>$config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/');<br /> $config['javascript_ajax_img'] = 'images/ajax-loader.gif';</code></p> <p>If you keep your files in the same directories they were downloaded from, then you need not set this configuration items.</p> -<p>For information on outputting events, effects, etc., refer to the <a href="jquery.html">jQuery Class</a> documentation.</p> +<h2>The jQuery Class</h2> + +<p>To initialize the jQuery class manually in your controller constructor, use the <dfn>$this->load->library</dfn> function:</p> + +<code>$this->load->library('jquery');</code> + +<p>You may send an optional parameter to determine whether or not a script tag for the main jQuery file will be automatically included when loading the library. It will be created by default. To prevent this, load the library as follows:</p> + +<code>$this->load->library('jquery', FALSE);</code> + +<p>Once loaded, the jQuery library object will be available using: <dfn>$this->jquery</dfn></p> + +<h2>jQuery Events</h2> + +<p>Events are set using the following syntax.</p> + +<p><code>$this->jquery->event('element_path', code_to_run());</code></p> + +<p>In the above example:</p> + +<ul> + <li>"event" is any of blur, change, click, dblclick, error, focus, hover, keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, scroll, or unload.</li> + <li>"element_path" is any valid <a href="http://docs.jquery.com/Selectors">jQuery selector</a>. Due to jQuery's unique selector syntax, this is usually an element id, or CSS selector. For example "#notice_area" would effect <div id="notice_area">, and "#content a.notice" would effect all anchors with a class of "notice" in the div with id "content".</li> + <li>"code_to_run()" is script your write yourself, or an action such as an effect from the jQuery library below.</li> + </ul> + +<h2>Effects</h2> + +<p>The query library supports a powerful <a href="http://docs.jquery.com/Effects">Effects</a> repertoire. Before an effect can be used, it must be loaded:</p> + +<p><code>$this->jquery->effect([optional path] plugin name); +// for example +$this->jquery->effect('bounce'); +</code></p> + +<h3>hide() / show()</h3> + +<p>Each of this functions will affect the visibility of an item on your page. hide() will set an item invisible, show() will reveal it.</p> +<p><code>$this->jquery->hide(target, optional speed, optional extra information);<br /> + $this->jquery->show(target, optional speed, optional extra information);</code></p> + +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> + <li>"extra information" is optional, and could include a callback, or other additional information.</li> +</ul> + +<h3>toggle()</h3> + +<p>toggle() will change the visibility of an item to the opposite of its current state, hiding visible elements, and revealing hidden ones.</p> +<p><code>$this->jquery->toggle(target);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> +</ul> + +<h3>animate()</h3> + +<p><code> $this->jquery->animate(target, parameters, optional speed, optional extra information);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"paramters" in jQuery would generally include a series of CSS properties that you wish to change.</li> + <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> + <li>"extra information" is optional, and could include a callback, or other additional information.</li> +</ul> +<p>For a full summary, see <a href="http://docs.jquery.com/Effects/animate">http://docs.jquery.com/Effects/animate</a></p> +<p>Here is an example of an animate() called on a div with an id of "note", and triggered by a click using the jQuery library's click() event.</p> +<p><code> $params = array(<br /> + 'height' => 80,<br /> + 'width' => '50%',<br /> + 'marginLeft' => 125<br /> +);<br /> +$this->jquery->click('#trigger', $this->jquery->animate('#note', $params, normal));</code></p> + +<h3>fadeIn() / fadeOut()</h3> + +<p><code>$this->jquery->fadeIn(target, optional speed, optional extra information);<br /> + $this->jquery->fadeOut(target, optional speed, optional extra information);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> + <li>"extra information" is optional, and could include a callback, or other additional information.</li> +</ul> + +<h3>toggleClass()</h3> + +<p>This function will add or remove a CSS class to its target.</p> +<p><code>$this->jquery->toggleClass(target, class)</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"class" is any CSS classname. Note that this class must be defined and available in a CSS that is already loaded.</li> + </ul> + +<h3>fadeIn() / fadeOut()</h3> + +<p>These effects cause an element(s) to disappear or reappear over time.</p> +<p><code>$this->jquery->fadeIn(target, optional speed, optional extra information);<br /> + $this->jquery->fadeOut(target, optional speed, optional extra information);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> + <li>"extra information" is optional, and could include a callback, or other additional information.</li> +</ul> + +<h3>slideUp() / slideDown() / slideToggle()</h3> + +<p>These effects cause an element(s) to slide.</p> +<p><code>$this->jquery->slideUp(target, optional speed, optional extra information);<br /> + $this->jquery->slideDown(target, optional speed, optional extra information);<br /> +$this->jquery->slideToggle(target, optional speed, optional extra information);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> + <li>"extra information" is optional, and could include a callback, or other additional information.</li> +</ul> + +<h2>Plugins</h2> + +<p> + +<p>Some select jQuery plugins are made available using this library.</p> + +<h3>corner()</h3> +<p>Used to add distinct corners to page elements. For full details see <a href="http://www.malsup.com/jquery/corner/">http://www.malsup.com/jquery/corner/</a></p> +<p><code>$this->jquery->corner(target, corner_style);</code></p> +<ul> + <li>"target" will be any valid jQuery selector or selectors.</li> + <li>"corner_style" is optional, and can be set to any valid style such as round, sharp, bevel, bite, dog, etc. Individual corners can be set by following the style with a space and using "tl" (top left), "tr" (top right), "bl" (bottom left), or "br" (bottom right).</li> +</ul> +<p><code>$this->jquery->corner("#note", "cool tl br");</code></p> + +<h3>tablesorter()</h3> + +<p>description to come</p> + +<h3>modal()</h3> + +<p>description to come</p> + +<h3>calendar()</h3> + +<p>description to come</p> + </div> <!-- END CONTENT --> diff --git a/user_guide/libraries/jquery.html b/user_guide/libraries/jquery.html deleted file mode 100644 index 732999c57..000000000 --- a/user_guide/libraries/jquery.html +++ /dev/null @@ -1,236 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> - -<title>CodeIgniter User Guide : Input Class</title> - -<style type='text/css' media='all'>@import url('../userguide.css');</style> -<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> - -<script type="text/javascript" src="../nav/nav.js"></script> -<script type="text/javascript" src="../nav/prototype.lite.js"></script> -<script type="text/javascript" src="../nav/moo.fx.js"></script> -<script type="text/javascript" src="../nav/user_guide_menu.js"></script> - -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta http-equiv='expires' content='-1' /> -<meta http-equiv= 'pragma' content='no-cache' /> -<meta name='robots' content='all' /> -<meta name='author' content='ExpressionEngine Dev Team' /> -<meta name='description' content='CodeIgniter User Guide' /> - -</head> -<body> - -<!-- START NAVIGATION --> -<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> -<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> -<div id="masthead"> -<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> -<tr> -<td><h1>CodeIgniter User Guide Version 2.0.0</h1></td> -<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> -</tr> -</table> -</div> -<!-- END NAVIGATION --> - - -<!-- START BREADCRUMB --> -<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> -<tr> -<td id="breadcrumb"> -<a href="http://codeigniter.com/">CodeIgniter Home</a> › -<a href="../index.html">User Guide Home</a> › -Input Class -</td> -<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> -</tr> -</table> -<!-- END BREADCRUMB --> - -<br clear="all" /> - - -<!-- START CONTENT --> -<div id="content"> - - -<h1>jQuery Class</h1> - -<p><a href="http://jquery.com/">jQuery</a> is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. CodeIgniter provides a library to help you with certain common functions that you may want to use within jQuery. Please note that CodeIgniter does not require the jQuery library to run, and that any scripting library will work equally well. The jQuery library is simply presented as a convenience if you choose to use it.</p> - -<h2>Initializing the Class</h2> - -<p>To initialize the jQuery class manually in your controller constructor, use the <dfn>$this->load->library</dfn> function:</p> - -<code>$this->load->library('jquery');</code> - -<p>You may send an optional parameter to determine whether or not a script tag for the main jQuery file will be automatically included when loading the library. It will be created by default. To prevent this, load the library as follows:</p> - -<code>$this->load->library('jquery', FALSE);</code> - -<p>Once loaded, the jQuery library object will be available using: <dfn>$this->jquery</dfn></p> - -<h2>Setup and Configuration</h2> - -<p>As a javascript library, jquery.js must be available to your application. For your convenience, the needed files to run this library are available for <a href="http://codeigniter.com/downloads/">download</a> from our site.</p> - -<p>As javascript is a client side language, the library must be able to write content into your final output. This generally means a view. You'll need to include the following variables in the <head> sections of your output.</p> - -<p><code><?php echo $jquery_script;?><br /> -<?php echo $script_head;?></code></p> - -<p>There are 2 configuration items in jQuery library. These can either be set in application/config.php, or within any controller. The first is the path from the root of your site to the jquery library ('js' is the default) and the second is an image to be used as an "ajax loader", or progress indicator. Without one, the simple text message of "loading" will appear when Ajax calls need to be made.</p> - -<p><code>$config['javascript_folder'] = 'js';<br /> - $config['javascript_ajax_img'] = 'images/ajax-loader.gif';</code></p> - -<p>If you keep your files in the same directories they were downloaded from, then you needed set this configuration items.</p> - -<h2>Events</h2> - -<p>Events are set using the following syntax.</p> - -<p><code>$this->jquery->event('element_path', code_to_run());</code></p> - -<p>In the above example:</p> - -<ul> - <li>"event" is any of blur, change, click, dblclick, error, focus, hover, keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, scroll, or unload.</li> - <li>"element_path" is any valid <a href="http://docs.jquery.com/Selectors">jQuery selector</a>. Due to jQuery's unique selector syntax, this is usually an element id, or CSS selector. For example "#notice_area" would effect <div id="notice_area">, and "#content a.notice" would effect all anchors with a class of "notice" in the div with id "content".</li> - <li>"code_to_run()" is script your write yourself, or an action such as an effect from the jQuery library below.</li> - </ul> - -<h2>Effects</h2> - -<p>The query library supports a powerful <a href="http://docs.jquery.com/Effects">Effects</a> repertoire. Before an effect can be used, it must be loaded:</p> - -<p><code>$this->jquery->effect([optional path] plugin name); -// for example -$this->jquery->effect('bounce'); -</code></p> - -<h3>hide() / show()</h3> - -<p>Each of this functions will affect the visibility of an item on your page. hide() will set an item invisible, show() will reveal it.</p> -<p><code>$this->jquery->hide(target, optional speed, optional extra information);<br /> - $this->jquery->show(target, optional speed, optional extra information);</code></p> - -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> - <li>"extra information" is optional, and could include a callback, or other additional information.</li> -</ul> - -<h3>toggle()</h3> - -<p>toggle() will change the visibility of an item to the opposite of its current state, hiding visible elements, and revealing hidden ones.</p> -<p><code>$this->jquery->toggle(target);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> -</ul> - -<h3>animate()</h3> - -<p><code> $this->jquery->animate(target, parameters, optional speed, optional extra information);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"paramters" in jQuery would generally include a series of CSS properties that you wish to change.</li> - <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> - <li>"extra information" is optional, and could include a callback, or other additional information.</li> -</ul> -<p>For a full summary, see <a href="http://docs.jquery.com/Effects/animate">http://docs.jquery.com/Effects/animate</a></p> -<p>Here is an example of an animate() called on a div with an id of "note", and triggered by a click using the jQuery library's click() event.</p> -<p><code> $params = array(<br /> - 'height' => 80,<br /> - 'width' => '50%',<br /> - 'marginLeft' => 125<br /> -);<br /> -$this->jquery->click('#trigger', $this->jquery->animate('#note', $params, normal));</code></p> - -<h3>fadeIn() / fadeOut()</h3> - -<p><code>$this->jquery->fadeIn(target, optional speed, optional extra information);<br /> - $this->jquery->fadeOut(target, optional speed, optional extra information);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> - <li>"extra information" is optional, and could include a callback, or other additional information.</li> -</ul> - -<h3>toggleClass()</h3> - -<p>This function will add or remove a CSS class to its target.</p> -<p><code>$this->jquery->toggleClass(target, class)</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"class" is any CSS classname. Note that this class must be defined and available in a CSS that is already loaded.</li> - </ul> - -<h3>fadeIn() / fadeOut()</h3> - -<p>These effects cause an element(s) to disappear or reappear over time.</p> -<p><code>$this->jquery->fadeIn(target, optional speed, optional extra information);<br /> - $this->jquery->fadeOut(target, optional speed, optional extra information);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> - <li>"extra information" is optional, and could include a callback, or other additional information.</li> -</ul> - -<h3>slideUp() / slideDown() / slideToggle()</h3> - -<p>These effects cause an element(s) to slide.</p> -<p><code>$this->jquery->slideUp(target, optional speed, optional extra information);<br /> - $this->jquery->slideDown(target, optional speed, optional extra information);<br /> -$this->jquery->slideToggle(target, optional speed, optional extra information);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"speed" is optional, and is set to either slow, normal, fast, or alternatively a number of milliseconds.</li> - <li>"extra information" is optional, and could include a callback, or other additional information.</li> -</ul> - -<h2>Plugins</h2> - -<p> - -<p>Some select jQuery plugins are made available using this library.</p> - -<h3>corner()</h3> -<p>Used to add distinct corners to page elements. For full details see <a href="http://www.malsup.com/jquery/corner/">http://www.malsup.com/jquery/corner/</a></p> -<p><code>$this->jquery->corner(target, corner_style);</code></p> -<ul> - <li>"target" will be any valid jQuery selector or selectors.</li> - <li>"corner_style" is optional, and can be set to any valid style such as round, sharp, bevel, bite, dog, etc. Individual corners can be set by following the style with a space and using "tl" (top left), "tr" (top right), "bl" (bottom left), or "br" (bottom right).</li> -</ul> -<p><code>$this->jquery->corner("#note", "cool tl br");</code></p> - -<h3>tablesorter()</h3> - -<p>description to come</p> - -<h3>modal()</h3> - -<p>description to come</p> - -<h3>calendar()</h3> - -<p>description to come</p> - -</div> -<!-- END CONTENT --> - - -<div id="footer"> -<p> -Previous Topic: <a href="input.html">Input Class</a> - · -<a href="#top">Top of Page</a> · -<a href="../index.html">User Guide Home</a> · -Next Topic: <a href="language.html">Language Class</a></p> -<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2011 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> -</div> - -</body> -</html>
\ No newline at end of file diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index f1c215c4d..8f16e275f 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -87,6 +87,7 @@ function create_menu(basepath) '<li><a href="'+base+'libraries/table.html">HTML Table Class</a></li>' + '<li><a href="'+base+'libraries/image_lib.html">Image Manipulation Class</a></li>' + '<li><a href="'+base+'libraries/input.html">Input Class</a></li>' + + '<li><a href="'+base+'libraries/javascript.html">Javascript Class</a></li>' + '<li><a href="'+base+'libraries/loader.html">Loader Class</a></li>' + '<li><a href="'+base+'libraries/language.html">Language Class</a></li>' + '<li><a href="'+base+'libraries/output.html">Output Class</a></li>' + diff --git a/user_guide/toc.html b/user_guide/toc.html index 68a7569f8..5eb9c2acc 100644 --- a/user_guide/toc.html +++ b/user_guide/toc.html @@ -136,6 +136,7 @@ Table of Contents <li><a href="./libraries/table.html">HTML Table Class</a></li> <li><a href="./libraries/image_lib.html">Image Manipulation Class</a></li> <li><a href="./libraries/input.html">Input Class</a></li> +<li><a href="./libraries/javascript.html">Javascript Class</a></li> <li><a href="./libraries/loader.html">Loader Class</a></li> <li><a href="./libraries/language.html">Language Class</a></li> <li><a href="./libraries/output.html">Output Class</a></li> |