| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>jQuery UI spinner documentation</title> |
| |
| <style> |
| body { |
| font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" |
| } |
| .gutter { |
| display: none; |
| } |
| </style> |
| </head> |
| <body> |
| |
| <script>{ |
| "title": |
| "Spinner Widget", |
| "excerpt": |
| "\n\t\tEnhance a text input for entering numeric values, with up/down buttons and arrow key handling.\n\t", |
| "termSlugs": { |
| "category": [ |
| "widgets" |
| ] |
| } |
| }</script><article id="spinner1" class="entry widget"><h2 class="section-title"> |
| <span>Spinner Widget</span><span class="version-details">version added: 1.9</span> |
| </h2> |
| <div class="entry-wrapper"> |
| <p class="desc"><strong>Description: </strong> |
| Enhance a text input for entering numeric values, with up/down buttons and arrow key handling. |
| </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-culture">culture</a></div> |
| <div><a href="#option-disabled">disabled</a></div> |
| <div><a href="#option-icons">icons</a></div> |
| <div><a href="#option-incremental">incremental</a></div> |
| <div><a href="#option-max">max</a></div> |
| <div><a href="#option-min">min</a></div> |
| <div><a href="#option-numberFormat">numberFormat</a></div> |
| <div><a href="#option-page">page</a></div> |
| <div><a href="#option-step">step</a></div> |
| </div> |
| <div class="quick-nav-section"> |
| <h3>Methods</h3> |
| <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-pageDown">pageDown</a></div> |
| <div><a href="#method-pageUp">pageUp</a></div> |
| <div><a href="#method-stepDown">stepDown</a></div> |
| <div><a href="#method-stepUp">stepUp</a></div> |
| <div><a href="#method-value">value</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-create">create</a></div> |
| <div><a href="#event-spin">spin</a></div> |
| <div><a href="#event-start">start</a></div> |
| <div><a href="#event-stop">stop</a></div> |
| </div></section><div class="longdesc" id="entry-longdesc"> |
| <p>Spinner, or number stepper, widget is perfect for handling all kinds of numeric input. It allow users to type a value directly or modify an existing value by spinning with the keyboard, mouse or scrollwheel. When combined with Globalize, you can even spin currencies and dates in a variety of locales.</p> |
| |
| <p>Spinner wraps a text input, adds two buttons to increment and decrement the current value, along with handling key events for the same purpose. It delegates to <a href="https://github.com/jquery/globalize">Globalize</a> for number formatting and parsing.</p> |
| |
| <h3>Keyboard interaction</h3> |
| |
| <ul> |
| <li>UP: Increment the value by one step.</li> |
| <li>DOWN: Decrement the value by one step.</li> |
| <li>PAGE UP: Increment the value by one page.</li> |
| <li>PAGE DOWN: Decrement the value by one page.</li> |
| </ul> |
| |
| <p>Focus stays in the text field, even after using the mouse to click one of the spin buttons.</p> |
| |
| <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="/button/">Button</a></li> |
| <li> |
| <a href="https://github.com/jquery/globalize">Globalize</a> (external, optional; for use with the <a href="#option-culture"><code>culture</code></a> and <a href="#option-numberFormat"><code>numberFormat</code></a> options)</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-culture" class="api-item first-item"> |
| <h3>culture<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>null</code> |
| </div> |
| <div>Sets the culture to use for parsing and formatting the value. If <code>null</code>, the currently set culture in <code>Globalize</code> is used, see <a href="https://github.com/jquery/globalize">Globalize docs</a> for available cultures. Only relevant if the <a href="#option-numberFormat"><code>numberFormat</code></a> option is set. Requires <a href="https://github.com/jquery/globalize">Globalize</a> to be included.</div> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>culture</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> ).spinner({ culture: <span class="string">"fr"</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>culture</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> culture = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"culture"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"culture"</span>, <span class="string">"fr"</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 spinner if set to <code>true</code>.</div> |
| <strong>Code examples:</strong><p>Initialize the spinner 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> ).spinner({ 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> ).spinner( <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> ).spinner( <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-icons" class="api-item"> |
| <h3>icons<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>{ down: "ui-icon-triangle-1-s", up: "ui-icon-triangle-1-n" }</code> |
| </div> |
| <div> |
| Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework. |
| <ul> |
| <li>up (string, default: "ui-icon-triangle-1-n")</li> |
| <li>down (string, default: "ui-icon-triangle-1-s")</li> |
| </ul> |
| </div> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>icons</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> ).spinner({ icons: { down: <span class="string">"custom-down-icon"</span>, up: <span class="string">"custom-up-icon"</span> } });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>icons</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> icons = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"icons"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"icons"</span>, { down: <span class="string">"custom-down-icon"</span>, up: <span class="string">"custom-up-icon"</span> } );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-incremental" class="api-item"> |
| <h3>incremental<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Boolean">Boolean</a> or <a href="http://api.jquery.com/Types/#Function">Function</a>( <a href="http://api.jquery.com/Types/#Integer">Integer</a> count )</span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>true</code> |
| </div> |
| <div>Controls the number of steps taken when holding down a spin button.</div> |
| <strong>Multiple types supported:</strong><ul> |
| <li> |
| <strong>Boolean</strong>: When set to <code>true</code>, the stepping delta will increase when spun incessantly. When set to <code>false</code>, all steps are equal (as defined by the <a href="#option-step"><code>step</code></a> option).</li> |
| <li> |
| <strong>Function</strong>: Receives one parameter: the number of spins that have occurred. Must return the number of steps that should occur for the current spin.</li> |
| </ul> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>incremental</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> ).spinner({ incremental: <span class="literal">false</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>incremental</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> incremental = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"incremental"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"incremental"</span>, <span class="literal">false</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-max" class="api-item"> |
| <h3>max<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>null</code> |
| </div> |
| <div>The maximum allowed value. The element's <code>max</code> attribute is used if it exists and the option is not explicitly set. If <code>null</code>, there is no maximum enforced.</div> |
| <strong>Multiple types supported:</strong><ul> |
| <li> |
| <strong>Number</strong>: The maximum value.</li> |
| <li> |
| <strong>String</strong>: If <a href="https://github.com/jquery/globalize">Globalize</a> is included, the <code>max</code> option can be passed as a string which will be parsed based on the <a href="#opiton-numberFormat"><code>numberFormat</code></a> and <a href="#option-culture"><code>culture</code></a> options; otherwise it will fall back to the native <code>parseFloat()</code> method.</li> |
| </ul> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>max</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> ).spinner({ max: <span class="number">50</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>max</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> max = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"max"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"max"</span>, <span class="number">50</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-min" class="api-item"> |
| <h3>min<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>null</code> |
| </div> |
| <div>The minimum allowed value. The element's <code>min</code> attribute is used if it exists and the option is not explicitly set. If <code>null</code>, there is no minimum enforced.</div> |
| <strong>Multiple types supported:</strong><ul> |
| <li> |
| <strong>Number</strong>: The minimum value.</li> |
| <li> |
| <strong>String</strong>: If <a href="https://github.com/jquery/globalize">Globalize</a> is included, the <code>min</code> option can be passed as a string which will be parsed based on the <a href="#opiton-numberFormat"><code>numberFormat</code></a> and <a href="#option-culture"><code>culture</code></a> options; otherwise it will fall back to the native <code>parseFloat()</code> method.</li> |
| </ul> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>min</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> ).spinner({ min: <span class="number">0</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>min</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> min = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"min"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"min"</span>, <span class="number">0</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-numberFormat" class="api-item"> |
| <h3>numberFormat<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#String">String</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>null</code> |
| </div> |
| <div>Format of numbers passed to <a href="https://github.com/jquery/globalize"><code>Globalize</code></a>, if available. Most common are <code>"n"</code> for a decimal number and <code>"C"</code> for a currency value. Also see the <a href="#option-culture"><code>culture</code></a> option.</div> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>numberFormat</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> ).spinner({ numberFormat: <span class="string">"n"</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>numberFormat</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> numberFormat = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"numberFormat"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"numberFormat"</span>, <span class="string">"n"</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-page" class="api-item"> |
| <h3>page<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>10</code> |
| </div> |
| <div>The number of steps to take when paging via the <a href="#method-pageUp"><code>pageUp</code></a>/<a href="#method-pageDown"><code>pageDown</code></a> methods.</div> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>page</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> ).spinner({ page: <span class="number">5</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>page</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> page = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"page"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"page"</span>, <span class="number">5</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-step" class="api-item"> |
| <h3>step<span class="option-type"><strong>Type: </strong><a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a></span> |
| </h3> |
| <div class="default"> |
| <strong>Default: </strong><code>1</code> |
| </div> |
| <div>The size of the step to take when spinning via buttons or via the <a href="#method-stepUp"><code>stepUp()</code></a>/<a href="#method-stepDown"><code>stepDown()</code></a> methods. The element's <code>step</code> attribute is used if it exists and the option is not explicitly set.</div> |
| <strong>Multiple types supported:</strong><ul> |
| <li> |
| <strong>Number</strong>: The size of the step.</li> |
| <li> |
| <strong>String</strong>: If <a href="https://github.com/jquery/globalize">Globalize</a> is included, the <code>step</code> option can be passed as a string which will be parsed based on the <a href="#opiton-numberFormat"><code>numberFormat</code></a> and <a href="#option-culture"><code>culture</code></a> options, otherwise it will fall back to the native <code>parseFloat</code>.</li> |
| </ul> |
| <strong>Code examples:</strong><p>Initialize the spinner with the <code>step</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> ).spinner({ step: <span class="number">2</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>step</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> step = $( <span class="string">".selector"</span> ).spinner( <span class="string">"option"</span>, <span class="string">"step"</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> ).spinner( <span class="string">"option"</span>, <span class="string">"step"</span>, <span class="number">2</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div></section><section id="methods"><header><h2>Methods</h2></header><div id="method-destroy"><div class="api-item first-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 spinner 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> ).spinner( <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 spinner. |
| </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> ).spinner( <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 spinner. |
| </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> ).spinner( <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> ).spinner( <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 spinner 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> ).spinner( <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 spinner 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> ).spinner( <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 spinner.</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> ).spinner( <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-pageDown"><div class="api-item"> |
| <h3>pageDown( [pages ] )<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> |
| Decrements the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is decremented. |
| </div> |
| <ul><li> |
| <div><strong>pages</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>Number of pages to decrement, defaults to 1.</div> |
| </li></ul> |
| <div> |
| <strong>Code examples:</strong><p>Invoke the pageDown 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> ).spinner( <span class="string">"pageDown"</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div></div> |
| <div id="method-pageUp"><div class="api-item"> |
| <h3>pageUp( [pages ] )<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> |
| Increments the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is incremented. |
| </div> |
| <ul><li> |
| <div><strong>pages</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>Number of pages to increment, defaults to 1.</div> |
| </li></ul> |
| <div> |
| <strong>Code examples:</strong><p>Invoke the pageUp 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> ).spinner( <span class="string">"pageUp"</span>, <span class="number">10</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div></div> |
| <div id="method-stepDown"><div class="api-item"> |
| <h3>stepDown( [steps ] )<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> |
| Decrements the value by the specified number of steps. Without the parameter, a single step is decremented. |
| <p>If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.</p> |
| </div> |
| <ul><li> |
| <div><strong>steps</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>Number of steps to decrement, defaults to 1.</div> |
| </li></ul> |
| <div> |
| <strong>Code examples:</strong><p>Invoke the stepDown 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> ).spinner( <span class="string">"stepDown"</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div></div> |
| <div id="method-stepUp"><div class="api-item"> |
| <h3>stepUp( [steps ] )<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> |
| Increments the value by the specified number of steps. Without the parameter, a single step is incremented. |
| <p>If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.</p> |
| </div> |
| <ul><li> |
| <div><strong>steps</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>Number of steps to increment, defaults to 1.</div> |
| </li></ul> |
| <div> |
| <strong>Code examples:</strong><p>Invoke the stepUp 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> ).spinner( <span class="string">"stepUp"</span>, <span class="number">5</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div></div> |
| <div id="method-value"> |
| <div class="api-item"> |
| <h3>value()<span class="returns">Returns: <a href="http://api.jquery.com/Types/#Number">Number</a></span> |
| </h3> |
| <div>Gets the current value as a number. The value is parsed based on the <a href="#option-numberFormat"><code>numberFormat</code></a> and <a href="#option-culture"><code>culture</code></a> options.</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> value = $( <span class="string">".selector"</span> ).spinner( <span class="string">"value"</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div> |
| <div class="api-item"> |
| <h3>value( 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></div> |
| <ul><li> |
| <div><strong>value</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> or <a href="http://api.jquery.com/Types/#String">String</a> |
| </div> |
| <div>The value to set. If passed as a string, the value is parsed based on the <a href="#option-numberFormat"><code>numberFormat</code></a> and <a href="#option-culture"><code>culture</code></a> options.</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> ).spinner( <span class="string">"value"</span>, <span class="number">50</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 generated wrapper. |
| </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="keyword">var</span> widget = $( <span class="string">".selector"</span> ).spinner( <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>spinchange</code></span> |
| </h3> |
| <div> |
| Triggered when the value of the spinner has changed and the input is no longer focused. |
| </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 spinner 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> ).spinner({</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 spinchange 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">"spinchange"</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>spincreate</code></span> |
| </h3> |
| <div> |
| Triggered when the spinner 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 spinner 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> ).spinner({</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 spincreate 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">"spincreate"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div> |
| <div id="event-spin" class="api-item"> |
| <h3>spin( event, ui )<span class="returns">Type: <code>spin</code></span> |
| </h3> |
| <div> |
| Triggered during increment/decrement (to determine direction of spin compare current value with <code>ui.value</code>). |
| <p>Can be canceled, preventing the value from being updated.</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>value</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>The new value to be set, unless the event is cancelled.</div> |
| </li></ul> |
| </li> |
| </ul> |
| <div> |
| <strong>Code examples:</strong><p>Initialize the spinner with the spin 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> ).spinner({</code></div></div><div class="container"><div class="line"><code> spin: <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 spin 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">"spin"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div> |
| <div id="event-start" class="api-item"> |
| <h3>start( event, ui )<span class="returns">Type: <code>spinstart</code></span> |
| </h3> |
| <div> |
| Triggered before a spin. Can be canceled, preventing the spin from occurring. |
| </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 spinner with the start 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> ).spinner({</code></div></div><div class="container"><div class="line"><code> start: <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 spinstart 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">"spinstart"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div> |
| <div id="event-stop" class="api-item"> |
| <h3>stop( event, ui )<span class="returns">Type: <code>spinstop</code></span> |
| </h3> |
| <div>Triggered after a spin.</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 spinner with the stop 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> ).spinner({</code></div></div><div class="container"><div class="line"><code> stop: <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 spinstop 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">"spinstop"</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>Example:</h2></header><div class="entry-example" id="example-0"> |
| <h4><span class="desc">Plain number spinner</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> |
| |
| </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>spinner 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">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">input</span> <span class="attribute">id</span>=<span class="value">"spinner"</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">"#spinner"</span> ).spinner();</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="50"></div> |
| </div></section> |
| </div></article> |
| |
| </body> |
| </html> |
