http://git-wip-us.apache.org/repos/asf/james-site/blob/38b1b837/content/development-bundle/docs/autocomplete.html ---------------------------------------------------------------------- diff --git a/content/development-bundle/docs/autocomplete.html b/content/development-bundle/docs/autocomplete.html new file mode 100644 index 0000000..f72ba78 --- /dev/null +++ b/content/development-bundle/docs/autocomplete.html @@ -0,0 +1,1453 @@ +<!doctype html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>jQuery UI autocomplete documentation</title> + + <style> + body { + font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" + } + .gutter { + display: none; + } + </style> +</head> +<body> + +<script>{ + "title": + "Autocomplete Widget", + "excerpt": + "Autocomplete enables users to quickly find and select from a pre-populated list of values as they type, leveraging searching and filtering.", + "termSlugs": { + "category": [ + "widgets" + ] + } + }</script><article id="autocomplete1" class="entry widget"><h2 class="section-title"> +<span>Autocomplete Widget</span><span class="version-details">version added: 1.8</span> +</h2> +<div class="entry-wrapper"> +<p class="desc"><strong>Description: </strong>Autocomplete enables users to quickly find and select from a pre-populated list of values as they type, leveraging searching and filtering.</p> +<section id="quick-nav"><header><h2>QuickNav<a href="#entry-examples">Examples</a> +</h2></header><div class="quick-nav-section"> +<h3>Options</h3> +<div><a href="#option-appendTo">appendTo</a></div> +<div><a href="#option-autoFocus">autoFocus</a></div> +<div><a href="#option-delay">delay</a></div> +<div><a href="#option-disabled">disabled</a></div> +<div><a href="#option-minLength">minLength</a></div> +<div><a href="#option-position">position</a></div> +<div><a href="#option-source">source</a></div> +</div> +<div class="quick-nav-section"> +<h3>Methods</h3> +<div><a href="#method-close">close</a></div> +<div><a href="#method-destroy">destroy</a></div> +<div><a href="#method-disable">disable</a></div> +<div><a href="#method-enable">enable</a></div> +<div><a href="#method-option">option</a></div> +<div><a href="#method-search">search</a></div> +<div><a href="#method-widget">widget</a></div> +</div> +<div class="quick-nav-section"> +<h3>Events</h3> +<div><a href="#event-change">change</a></div> +<div><a href="#event-close">close</a></div> +<div><a href="#event-create">create</a></div> +<div><a href="#event-focus">focus</a></div> +<div><a href="#event-open">open</a></div> +<div><a href="#event-response">response</a></div> +<div><a href="#event-search">search</a></div> +<div><a href="#event-select">select</a></div> +</div></section><div class="longdesc" id="entry-longdesc"> + <p>By giving an Autocomplete field focus or entering something into it, the plugin starts searching for entries that match and displays a list of values to choose from. By entering more characters, the user can filter down the list to better matches.</p> + + <p>This can be used to choose previously selected values, such as entering tags for articles or entering email addresses from an address book. Autocomplete can also be used to populate associated information, such as entering a city name and getting the zip code.</p> + + <p>You can pull data in from a local or remote source: Local is good for small data sets, e.g., an address book with 50 entries; remote is necessary for big data sets, such as a database with hundreds or millions of entries to select from. To find out more about customizing the data soure, see the documentation for the <a href="#option-source"><code>source</code></a> option.</p> + + <h3>Keyboard interaction</h3> + + <p>When the menu is open, the following key commands are available:</p> + <ul> + <li>UP - Move focus to the previous item. If on first item, move focus to the input. If on the input, move focus to last item.</li> + <li>DOWN - Move focus to the next item. If on last item, move focus to the input. If on the input, move focus to the first item.</li> + <li>ESCAPE - Close the menu.</li> + <li>ENTER - Select the currently focused item and close the menu.</li> + <li>TAB - Select the currently focused item, close the menu, and move focus to the next focusable element.</li> + <li>PAGE UP/DOWN - Scroll through a page of items (based on height of menu). <em>It's generally a bad idea to display so many items that users need to page.</em>.</li> + </ul> + + <p>When the menu is closed, the following key commands are available:</p> + <ul> + <li>UP/DOWN - Open the menu, if the <a href="#option-minLength"><code>minLength</code></a> has been met.</li> + </ul> + + <h3>Dependencies</h3> + <ul> + <li><a href="/category/ui-core/">UI Core</a></li> + <li><a href="/jQuery.widget/">Widget Factory</a></li> + <li><a href="/position/">Position</a></li> + <li><a href="/menu/">Menu</a></li> + </ul> + </div> +<h3>Additional Notes:</h3> +<div class="longdesc"><ul><li> + This widget requires some functional CSS, otherwise it won't work. If you build a custom theme, use the widget's specific CSS file as a starting point. + </li></ul></div> +<section id="options"><header><h2>Options</h2></header><div id="option-appendTo" class="api-item first-item"> +<h3>appendTo<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Selector";>Selector</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>"body"</code> +</div> +<div>Which element the menu should be appended to. Override this when the autocomplete is inside a <code>position: fixed</code> element. Otherwise the popup menu would still scroll with the page.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>appendTo</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ appendTo: <span class="string">"#someElem"</span> });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>appendTo</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> appendTo = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"appendTo"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"appendTo"</span>, <span class="string">"#someElem"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-autoFocus" class="api-item"> +<h3>autoFocus<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean";>Boolean</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>false</code> +</div> +<div>If set to <code>true</code> the first item will automatically be focused when the menu is shown.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>autoFocus</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ autoFocus: <span class="literal">true</span> });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>autoFocus</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> autoFocus = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"autoFocus"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"autoFocus"</span>, <span class="literal">true</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-delay" class="api-item"> +<h3>delay<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Integer";>Integer</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>300</code> +</div> +<div>The delay in milliseconds between when a keystroke occurs and when a search is performed. A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data, while being less responsive.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>delay</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ delay: <span class="number">500</span> });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>delay</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> delay = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"delay"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"delay"</span>, <span class="number">500</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-disabled" class="api-item"> +<h3>disabled<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean";>Boolean</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>false</code> +</div> +<div>Disables the autocomplete if set to <code>true</code>.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>disabled</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ disabled: <span class="literal">true</span> });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>disabled</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> disabled = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-minLength" class="api-item"> +<h3>minLength<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Integer";>Integer</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>1</code> +</div> +<div>The minimum number of characters a user must type before a search is performed. Zero is useful for local data with just a few items, but a higher value should be used when a single character search could match a few thousand items.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>minLength</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ minLength: <span class="number">0</span> });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>minLength</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> minLength = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"minLength"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"minLength"</span>, <span class="number">0</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-position" class="api-item"> +<h3>position<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Object";>Object</a></span> +</h3> +<div class="default"> +<strong>Default: </strong><code>{ my: "left top", at: "left bottom", collision: "none" }</code> +</div> +<div>Identifies the position of the suggestions menu in relation to the associated input element. The <code>of</code> option defaults to the input element, but you can specify another element to position against. You can refer to the <a href="/position">jQuery UI Position</a> utility for more details about the various options.</div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>position</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ position: { my : <span class="string">"right top"</span>, at: <span class="string">"right bottom"</span> } });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>position</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> position = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"position"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"position"</span>, { my : <span class="string">"right top"</span>, at: <span class="string">"right bottom"</span> } );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +<div id="option-source" class="api-item"> +<h3>source<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Array";>Array</a> or <a href="http://api.jquery.com/Types/#String";>String</a> or <a href="http://api.jquery.com/Types/#Function";>Function</a>( <a href="http://api.jquery.com/Types/#Object";>Object</a> request, <a href="http://api.jquery.com/Types/#Function";>Function</a> response( <a href="http://api.jquery.com/Types/#Object";>Object</a> data ) )</span> +</h3> +<div class="default"> +<strong>Default: </strong><code>none; must be specified</code> +</div> +<div> + Defines the data to use, must be specified. + <p>Independent of the variant you use, the label is always treated as text. If you want the label to be treated as html you can use <a href="https://github.com/scottgonzalez/jquery-ui-extensions/blob/master/autocomplete/jquery.ui.autocomplete.html.js";>Scott González' html extension</a>. The demos all focus on different variations of the <code>source</code> option - look for one that matches your use case, and check out the code.</p> + </div> +<strong>Multiple types supported:</strong><ul> +<li> +<strong>Array</strong>: + An array can be used for local data. There are two supported formats: + <ul> + <li>An array of strings: <code>[ "Choice1", "Choice2" ]</code> +</li> + <li>An array of objects with <code>label</code> and <code>value</code> properties: <code>[ { label: "Choice1", value: "value1" }, ... ]</code> +</li> + </ul> + The label property is displayed in the suggestion menu. The value will be inserted into the input element when a user selects an item. If just one property is specified, it will be used for both, e.g., if you provide only <code>value</code> properties, the value will also be used as the label. + </li> +<li> +<strong>String</strong>: When a string is used, the Autocomplete plugin expects that string to point to a URL resource that will return JSON data. It can be on the same host or on a different one (must provide JSONP). The Autocomplete plugin does not filter the results, instead a query string is added with a <code>term</code> field, which the server-side script should use for filtering the results. For example, if the <code>source</code> option is set to <code>"http://example.com";</code> and the user types <code>foo</code>, a GET request would be made to <code>http://example.com?term=foo</code>. The data itself can be in the same format as the local data described above.</li> +<li> +<strong>Function</strong>: + The third variation, a callback, provides the most flexibility and can be used to connect any data source to Autocomplete. The callback gets two arguments: + <ul> + <li>A <code>request</code> object, with a single <code>term</code> property, which refers to the value currently in the text input. For example, if the user enters <code>"new yo"</code> in a city field, the Autocomplete term will equal <code>"new yo"</code>.</li> + <li>A <code>response</code> callback, which expects a single argument: the data to suggest to the user. This data should be filtered based on the provided term, and can be in any of the formats described above for simple local data. It's important when providing a custom source callback to handle errors during the request. You must always call the <code>response</code> callback even if you encounter an error. This ensures that the widget always has the correct state.</li> + </ul> + <p>When filtering data locally, you can make use of the built-in <code>$.ui.autocomplete.escapeRegex</code> function. It'll take a single string argument and escape all regex characters, making the result safe to pass to <code>new RegExp()</code>.</p> + </li> +</ul> +<strong>Code examples:</strong><p>Initialize the autocomplete with the <code>source</code> option specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({ source: [ <span class="string">"c++"</span>, <span class="string">"java"</span>, <span class="string">"php"</span>, <span class="string">"coldfusion"</span>, <span class="string">"javascript"</span>, <span class="string">"asp"</span>, <span class="string">"ruby"</span> ] });</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Get or set the <code>source</code> option, after initialization:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="comment">// getter</span></code></div></div><div class="container"><div class="line"><code><span class="keyword">var</span> source = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"source"</span> );</code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="comment">// setter</span></code></div></div><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"source"</span>, [ <span class="string">"c++"</span>, <span class="string">"java"</span>, <span class="string">"php"</span>, <span class="string">"coldfusion"</span>, <span class="string">"javascript"</span>, <span class="string">"asp"</span>, <span class="string">"ruby"</span> ] );</code></div></div>< /pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div></section><section id="methods"><header><h2>Methods</h2></header><div id="method-close"><div class="api-item first-item"> +<h3>close()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div>Closes the Autocomplete menu. Useful in combination with the <a href="#method-search"><code>search</code></a> method, to close the open menu.</div> +<ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the close method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"close"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div> +<div id="method-destroy"><div class="api-item"> +<h3>destroy()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div> + Removes the autocomplete functionality completely. This will return the element back to its pre-init state. + </div> +<ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the destroy method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"destroy"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div> +<div id="method-disable"><div class="api-item"> +<h3>disable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div> + Disables the autocomplete. + </div> +<ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the disable method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"disable"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div> +<div id="method-enable"><div class="api-item"> +<h3>enable()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div> + Enables the autocomplete. + </div> +<ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the enable method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"enable"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div> +<div id="method-option"> +<div class="api-item"> +<h3>option( optionName )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#Object";>Object</a></span> +</h3> +<div>Gets the value currently associated with the specified <code>optionName</code>.</div> +<ul><li> +<div><strong>optionName</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#String";>String</a> +</div> +<div>The name of the option to get.</div> +</li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="keyword">var</span> isDisabled = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"disabled"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div class="api-item"> +<h3>option()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#PlainObject";>PlainObject</a></span> +</h3> +<div>Gets an object containing key/value pairs representing the current autocomplete options hash.</div> +<ul><li><div class="null-signature">This signature does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="keyword">var</span> options = $( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div class="api-item"> +<h3>option( optionName, value )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div>Sets the value of the autocomplete option associated with the specified <code>optionName</code>.</div> +<ul> +<li> +<div><strong>optionName</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#String";>String</a> +</div> +<div>The name of the option to set.</div> +</li> +<li> +<div><strong>value</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div>A value to set for the option.</div> +</li> +</ul> +<div> +<strong>Code examples:</strong><p>Invoke the method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, <span class="string">"disabled"</span>, <span class="literal">true</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div class="api-item"> +<h3>option( options )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div>Sets one or more options for the autocomplete.</div> +<ul><li> +<div><strong>options</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div>A map of option-value pairs to set.</div> +</li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"option"</span>, { disabled: <span class="literal">true</span> } );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +</div> +<div id="method-search"><div class="api-item"> +<h3>search( [value ] )<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> (<a href="http://learn.jquery.com/jquery-ui/widget-factory/widget-method-invocation/";>plugin only</a>)</span> +</h3> +<div>Triggers a <a href="#event-search"><code>search</code></a> event and invokes the data source if the event is not canceled. Can be used by a selectbox-like button to open the suggestions when clicked. When invoked with no parameters, the current input's value is used. Can be called with an empty string and <code>minLength: 0</code> to display all items.</div> +<ul><li> +<div><strong>value</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#String";>String</a> +</div> +<div></div> +</li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the search method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"search"</span>, <span class="string">""</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div> +<div id="method-widget"><div class="api-item"> +<h3>widget()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a></span> +</h3> +<div>Returns a <code>jQuery</code> object containing the menu element. Although the menu items are constantly created and destroyed, the menu element itself is created during initialization and is constantly reused.</div> +<ul><li><div class="null-signature">This method does not accept any arguments.</div></li></ul> +<div> +<strong>Code examples:</strong><p>Invoke the widget method:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete( <span class="string">"widget"</span> );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></div></section><section id="events"><header><h2>Events</h2></header><div id="event-change" class="api-item first-item"> +<h3>change( event, ui )<span class="returns">Type: <code>autocompletechange</code></span> +</h3> +<div>Triggered when the field is blurred, if the value has changed.</div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +<ul><li> +<div><strong>item</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> +</div> +<div>The item selected from the menu, if any. Otherwise the property is <code>null</code>.</div> +</li></ul> +</li> +</ul> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the change callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> change: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompletechange event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompletechange"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-close" class="api-item"> +<h3>close( event, ui )<span class="returns">Type: <code>autocompleteclose</code></span> +</h3> +<div>Triggered when the menu is hidden. Not every <code>close</code> event will be accompanied by a <code>change</code> event.</div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +</li> +</ul> +<p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the close callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> close: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompleteclose event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompleteclose"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-create" class="api-item"> +<h3>create( event, ui )<span class="returns">Type: <code>autocompletecreate</code></span> +</h3> +<div> + Triggered when the autocomplete is created. + </div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +</li> +</ul> +<p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the create callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> create: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompletecreate event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompletecreate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-focus" class="api-item"> +<h3>focus( event, ui )<span class="returns">Type: <code>autocompletefocus</code></span> +</h3> +<div> + Triggered when focus is moved to an item (not selecting). The default action is to replace the text field's value with the value of the focused item, though only if the event was triggered by a keyboard interaction. + <p>Canceling this event prevents the value from being updated, but does not prevent the menu item from being focused.</p> + </div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +<ul><li> +<div><strong>item</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> +</div> +<div>The focused item.</div> +</li></ul> +</li> +</ul> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the focus callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> focus: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompletefocus event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompletefocus"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-open" class="api-item"> +<h3>open( event, ui )<span class="returns">Type: <code>autocompleteopen</code></span> +</h3> +<div>Triggered when the suggestion menu is opened or updated.</div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +</li> +</ul> +<p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the open callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> open: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompleteopen event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompleteopen"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-response" class="api-item"> +<h3>response( event, ui )<span class="returns">Type: <code>autocompleteresponse</code></span> +</h3> +<div>Triggered after a search completes, before the menu is shown. Useful for local manipulation of suggestion data, where a custom <a href="#option-source"><code>source</code></a> option callback is not required. This event is always triggered when a search completes, even if the menu will not be shown because there are no results or the Autocomplete is disabled.</div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +<ul><li> +<div><strong>content</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Array";>Array</a> +</div> +<div>Contains the response data and can be modified to change the results that will be shown. This data is already normalized, so if you modify the data, make sure to include both <code>value</code> and <code>label</code> properties for each item.</div> +</li></ul> +</li> +</ul> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the response callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> response: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompleteresponse event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompleteresponse"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-search" class="api-item"> +<h3>search( event, ui )<span class="returns">Type: <code>autocompletesearch</code></span> +</h3> +<div>Triggered before a search is performed, after <a href="#option-minLength"><code>minLength</code></a> and <a href="#option-delay"><code>delay</code></a> are met. If canceled, then no request will be started and no items suggested.</div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +</li> +</ul> +<p><em>Note: The <code>ui</code> object is empty but included for consistency with other events.</em></p> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the search callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> search: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompletesearch event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompletesearch"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div> +<div id="event-select" class="api-item"> +<h3>select( event, ui )<span class="returns">Type: <code>autocompleteselect</code></span> +</h3> +<div> + Triggered when an item is selected from the menu. The default action is to replace the text field's value with the value of the selected item. + <p>Canceling this event prevents the value from being updated, but does not prevent the menu from closing.</p> + </div> +<ul> +<li> +<div><strong>event</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Event";>Event</a> +</div> +<div></div> +</li> +<li> +<div><strong>ui</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#Object";>Object</a> +</div> +<div></div> +<ul><li> +<div><strong>item</strong></div> +<div>Type: <a href="http://api.jquery.com/Types/#jQuery";>jQuery</a> +</div> +<div>The selected item.</div> +</li></ul> +</li> +</ul> +<div> +<strong>Code examples:</strong><p>Initialize the autocomplete with the select callback specified:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> select: <span class="keyword">function</span>( event, ui ) {}</code></div></div><div class="container"><div class="line"><code>});</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<p>Bind an event listener to the autocompleteselect event:</p> +<div class="syntaxhighlighter javascript nogutter"> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code>$( <span class="string">".selector"</span> ).on( <span class="string">"autocompleteselect"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +</div> +</div></section><section class="entry-examples" id="entry-examples"><header><h2>Examples:</h2></header><div class="entry-example" id="example-0"> +<h4>Example: <span class="desc">A simple jQuery UI Autocomplete</span> +</h4> +<div class="syntaxhighlighter xml "> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + <div class="line n6">6</div> + + <div class="line n7">7</div> + + <div class="line n8">8</div> + + <div class="line n9">9</div> + + <div class="line n10">10</div> + + <div class="line n11">11</div> + + <div class="line n12">12</div> + + <div class="line n13">13</div> + + <div class="line n14">14</div> + + <div class="line n15">15</div> + + <div class="line n16">16</div> + + <div class="line n17">17</div> + + <div class="line n18">18</div> + + <div class="line n19">19</div> + + <div class="line n20">20</div> + + <div class="line n21">21</div> + + <div class="line n22">22</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="doctype"><!doctype html></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">title</span>></span>autocomplete demo<span class="tag"></<span class="title">title</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">link</span> <span class="attri bute">rel</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.8.3.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.9.2/jquery-ui.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">head</span>></span></code></div> </div><div class="container"><div class="line"><code><span class="tag"><<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">label</span> <span class="attribute">for</span>=<span class="value">"autocomplete"</span>></span>Select a programming language: <span class="tag"></<span class="title">label</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">input</span> <span class="attribute">id</span>=<span class="value">"autocomplete"</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">script</span>></span><span class="javascript"></span></code></div></div><div class="container"><div class="line"><code>$( < span class="string">"#autocomplete"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> source: [ <span class="string">"c++"</span>, <span class="string">"java"</span>, <span class="string">"php"</span>, <span class="string">"coldfusion"</span>, <span class="string">"javascript"</span>, <span class="string">"asp"</span>, <span class="string">"ruby"</span> ]</code></div></div><div class="container"><div class="line"><code>});</code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">html</span>></span></code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<h4>Demo:</h4> +<div class="demo code-demo"></div> +</div> +<div class="entry-example" id="example-1"> +<h4>Example: <span class="desc">Using a custom source callback to match only the beginning of terms</span> +</h4> +<div class="syntaxhighlighter xml "> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + <div class="line n6">6</div> + + <div class="line n7">7</div> + + <div class="line n8">8</div> + + <div class="line n9">9</div> + + <div class="line n10">10</div> + + <div class="line n11">11</div> + + <div class="line n12">12</div> + + <div class="line n13">13</div> + + <div class="line n14">14</div> + + <div class="line n15">15</div> + + <div class="line n16">16</div> + + <div class="line n17">17</div> + + <div class="line n18">18</div> + + <div class="line n19">19</div> + + <div class="line n20">20</div> + + <div class="line n21">21</div> + + <div class="line n22">22</div> + + <div class="line n23">23</div> + + <div class="line n24">24</div> + + <div class="line n25">25</div> + + <div class="line n26">26</div> + + <div class="line n27">27</div> + + <div class="line n28">28</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="doctype"><!doctype html></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">title</span>></span>autocomplete demo<span class="tag"></<span class="title">title</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">link</span> <span class="attri bute">rel</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.8.3.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.9.2/jquery-ui.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">head</span>></span></code></div> </div><div class="container"><div class="line"><code><span class="tag"><<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">label</span> <span class="attribute">for</span>=<span class="value">"autocomplete"</span>></span>Select a programming language: <span class="tag"></<span class="title">label</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">input</span> <span class="attribute">id</span>=<span class="value">"autocomplete"</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">script</span>></span><span class="javascript"></span></code></div></div><div class="container"><div class="line"><code><spa n class="keyword">var</span> tags = [ <span class="string">"c++"</span>, <span class="string">"java"</span>, <span class="string">"php"</span>, <span class="string">"coldfusion"</span>, <span class="string">"javascript"</span>, <span class="string">"asp"</span>, <span class="string">"ruby"</span> ];</code></div></div><div class="container"><div class="line"><code>$( <span class="string">"#autocomplete"</span> ).autocomplete({</code></div></div><div class="container"><div class="line"><code> source: <span class="keyword">function</span>( request, response ) {</code></div></div><div class="container"><div class="line"><code> <span class="keyword">var</span> matcher = <span class="keyword">new</span> RegExp( <span class="string">"^"</span> + $.ui.autocomplete.escapeRegex( request.term ), <span class="string">"i"</span> );</code></div></div><div class="container"><div class="line"><code> response( $.grep( tags, <span class="keyword">function</span>( item ){</code></di v></div><div class="container"><div class="line"><code> <span class="keyword">return</span> matcher.test( item );</code></div></div><div class="container"><div class="line"><code> }) );</code></div></div><div class="container"><div class="line"><code> }</code></div></div><div class="container"><div class="line"><code>});</code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">html</span>></span></code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<h4>Demo:</h4> +<div class="demo code-demo"></div> +</div></section> +</div></article> + +</body> +</html>
http://git-wip-us.apache.org/repos/asf/james-site/blob/38b1b837/content/development-bundle/docs/blind-effect.html ---------------------------------------------------------------------- diff --git a/content/development-bundle/docs/blind-effect.html b/content/development-bundle/docs/blind-effect.html new file mode 100644 index 0000000..be16bff --- /dev/null +++ b/content/development-bundle/docs/blind-effect.html @@ -0,0 +1,130 @@ +<!doctype html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>jQuery UI blind-effect documentation</title> + + <style> + body { + font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" + } + .gutter { + display: none; + } + </style> +</head> +<body> + +<script>{ + "title": + "Blind Effect", + "excerpt": + "\n\t\tThe blind effect hides or shows an element by wrapping the element in a container, and \"pulling the blinds\"\n\t", + "termSlugs": { + "category": [ + "effects" + ] + } + }</script><article id="blind1" class="entry effect"><h2 class="section-title"><span>Blind Effect</span></h2> +<div class="entry-wrapper"> +<p class="desc"><strong>Description: </strong> + The blind effect hides or shows an element by wrapping the element in a container, and "pulling the blinds" + </p> +<ul class="signatures"><li class="signature"> +<h4 class="name">blind</h4> +<ul><li> +<div> +<strong>direction</strong> (default: <code>"up"</code>)</div> +<div>Type: <a href="http://api.jquery.com/Types/#String";>String</a> +</div> +<div> + <p>The direction the blind will be pulled to hide the element, or the direction from which the element will be revealed.</p> + <p>Possible Values: <code>up</code>, <code>down</code>, <code>left</code>, <code>right</code>, <code>vertical</code>, <code>horizontal</code>.</p> + </div> +</li></ul> +</li></ul> +<div class="longdesc" id="entry-longdesc"> + <p>The container has <code>overflow: hidden</code> applied, so height changes affect what's visible.</p> + </div> +<section class="entry-examples" id="entry-examples"><header><h2>Example:</h2></header><div class="entry-example" id="example-0"> +<h4><span class="desc">Toggle a div using the blind effect.</span></h4> +<div class="syntaxhighlighter xml "> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + <div class="line n6">6</div> + + <div class="line n7">7</div> + + <div class="line n8">8</div> + + <div class="line n9">9</div> + + <div class="line n10">10</div> + + <div class="line n11">11</div> + + <div class="line n12">12</div> + + <div class="line n13">13</div> + + <div class="line n14">14</div> + + <div class="line n15">15</div> + + <div class="line n16">16</div> + + <div class="line n17">17</div> + + <div class="line n18">18</div> + + <div class="line n19">19</div> + + <div class="line n20">20</div> + + <div class="line n21">21</div> + + <div class="line n22">22</div> + + <div class="line n23">23</div> + + <div class="line n24">24</div> + + <div class="line n25">25</div> + + <div class="line n26">26</div> + + <div class="line n27">27</div> + + <div class="line n28">28</div> + + <div class="line n29">29</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="doctype"><!doctype html></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">title</span>></span>blind demo<span class="tag"></<span class="title">title</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">link</span> <span class="attribute">r el</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">style</span>></span><span class="css"></span></code></div></div><div class="container"><div class="line"><code> <span class="id">#toggle</span> <span class="rules">{</span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">width</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">height</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">background</span>:<span class ="value"> <span class="hexcolor">#ccc</span>;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule">}</span></code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">style</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.8.3.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.9.2/jquery-ui.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container" ><div class="line"><code><span class="tag"></<span >class="title">head</span>></span></code></div></div><div >class="container"><div class="line"><code><span class="tag"><<span >class="title">body</span>></span></code></div></div><div >class="container"><div class="line"><code> </code></div></div><div >class="container"><div class="line"><code><span class="tag"><<span >class="title">p</span>></span>Click anywhere to toggle the box.<span >class="tag"></<span >class="title">p</span>></span></code></div></div><div >class="container"><div class="line"><code><span class="tag"><<span >class="title">div</span> <span class="attribute">id</span>=<span >class="value">"toggle"</span>></span><span class="tag"></<span >class="title">div</span>></span></code></div></div><div >class="container"><div class="line"><code> </code></div></div><div >class="container"><div class="line"><code><span class="tag"><<span >class="title">script</span>></span><span class="javascript">< /span></code></div></div><div class="container"><div class="line"><code>$( document ).click(<span class="keyword">function</span>() {</code></div></div><div class="container"><div class="line"><code> $( <span class="string">"#toggle"</span> ).toggle( <span class="string">"blind"</span> );</code></div></div><div class="container"><div class="line"><code>});</code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">html</span>></span></code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<h4>Demo:</h4> +<div class="demo code-demo" data-height="200"></div> +</div></section> +</div></article> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/james-site/blob/38b1b837/content/development-bundle/docs/bounce-effect.html ---------------------------------------------------------------------- diff --git a/content/development-bundle/docs/bounce-effect.html b/content/development-bundle/docs/bounce-effect.html new file mode 100644 index 0000000..64f5c87 --- /dev/null +++ b/content/development-bundle/docs/bounce-effect.html @@ -0,0 +1,133 @@ +<!doctype html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>jQuery UI bounce-effect documentation</title> + + <style> + body { + font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" + } + .gutter { + display: none; + } + </style> +</head> +<body> + +<script>{ + "title": + "Bounce Effect", + "excerpt": + "\n\t\tThe bounce effect bounces an element. When used with hide or show, the last or first bounce will also fade in/out.\n\t", + "termSlugs": { + "category": [ + "effects" + ] + } + }</script><article id="bounce1" class="entry effect"><h2 class="section-title"><span>Bounce Effect</span></h2> +<div class="entry-wrapper"> +<p class="desc"><strong>Description: </strong> + The bounce effect bounces an element. When used with hide or show, the last or first bounce will also fade in/out. + </p> +<ul class="signatures"><li class="signature"> +<h4 class="name">bounce</h4> +<ul> +<li> +<div> +<strong>distance</strong> (default: <code>20</code>)</div> +<div>Type: <a href="http://api.jquery.com/Types/#Number";>Number</a> +</div> +<div>The distance of the largest "bounce" in pixels.</div> +</li> +<li> +<div> +<strong>times</strong> (default: <code>5</code>)</div> +<div>Type: <a href="http://api.jquery.com/Types/#Integer";>Integer</a> +</div> +<div>The number of times the element will bounce. When used with hide or show, there is an extra "half" bounce for the fade in/out.</div> +</li> +</ul> +</li></ul> +<section class="entry-examples" id="entry-examples"><header><h2>Example:</h2></header><div class="entry-example" id="example-0"> +<h4><span class="desc">Toggle a div using the bounce effect.</span></h4> +<div class="syntaxhighlighter xml "> + <table> + <tbody> + <tr> + <td class="gutter"> + + <div class="line n1">1</div> + + <div class="line n2">2</div> + + <div class="line n3">3</div> + + <div class="line n4">4</div> + + <div class="line n5">5</div> + + <div class="line n6">6</div> + + <div class="line n7">7</div> + + <div class="line n8">8</div> + + <div class="line n9">9</div> + + <div class="line n10">10</div> + + <div class="line n11">11</div> + + <div class="line n12">12</div> + + <div class="line n13">13</div> + + <div class="line n14">14</div> + + <div class="line n15">15</div> + + <div class="line n16">16</div> + + <div class="line n17">17</div> + + <div class="line n18">18</div> + + <div class="line n19">19</div> + + <div class="line n20">20</div> + + <div class="line n21">21</div> + + <div class="line n22">22</div> + + <div class="line n23">23</div> + + <div class="line n24">24</div> + + <div class="line n25">25</div> + + <div class="line n26">26</div> + + <div class="line n27">27</div> + + <div class="line n28">28</div> + + <div class="line n29">29</div> + + </td> + <td class="code"> + <pre><div class="container"><div class="line"><code><span class="doctype"><!doctype html></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">html</span> <span class="attribute">lang</span>=<span class="value">"en"</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">meta</span> <span class="attribute">charset</span>=<span class="value">"utf-8"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">title</span>></span>bounce demo<span class="tag"></<span class="title">title</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">link</span> <span class="attribute"> rel</span>=<span class="value">"stylesheet"</span> <span class="attribute">href</span>=<span class="value">"//code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css"</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">style</span>></span><span class="css"></span></code></div></div><div class="container"><div class="line"><code> <span class="id">#toggle</span> <span class="rules">{</span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">width</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">height</span>:<span class="value"> <span class="number">100</span>px;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule"><span class="attribute">background</span>:<span clas s="value"> <span class="hexcolor">#ccc</span>;</span></span></code></div></div><div class="container"><div class="line"><code> <span class="rule">}</span></code></div></div><div class="container"><div class="line"><code> <span class="tag"></<span class="title">style</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/jquery-1.8.3.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> <span class="tag"><<span class="title">script</span> <span class="attribute">src</span>=<span class="value">"//code.jquery.com/ui/1.9.2/jquery-ui.js"</span>></span><span class="javascript"></span><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container "><div class="line"><code><span class="tag"></<span class="title">head</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">p</span>></span>Click anywhere to toggle the box.<span class="tag"></<span class="title">p</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">div</span> <span class="attribute">id</span>=<span class="value">"toggle"</span>></span><span class="tag"></<span class="title">div</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"><<span class="title">script</span>></span><span class="javascript"> </span></code></div></div><div class="container"><div class="line"><code>$( document ).click(<span class="keyword">function</span>() {</code></div></div><div class="container"><div class="line"><code> $( <span class="string">"#toggle"</span> ).toggle( <span class="string">"bounce"</span>, { times: <span class="number">3</span> }, <span class="string">"slow"</span> );</code></div></div><div class="container"><div class="line"><code>});</code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">script</span>></span></code></div></div><div class="container"><div class="line"><code> </code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">body</span>></span></code></div></div><div class="container"><div class="line"><code><span class="tag"></<span class="title">html</span>></span></code></div></div></pre> + </td> + </tr> + </tbody> + </table> +</div> + +<h4>Demo:</h4> +<div class="demo code-demo" data-height="200"></div> +</div></section> +</div></article> + +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
