| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>jQuery UI progressbar documentation</title> |
| |
| <style> |
| body { |
| font-family: "Trebuchet MS", "Arial", "Helvetica", "Verdana", "sans-serif" |
| } |
| .gutter { |
| display: none; |
| } |
| </style> |
| </head> |
| <body> |
| |
| <script>{ |
| "title": |
| "Progressbar Widget", |
| "excerpt": |
| "Display status of a determinate process.", |
| "termSlugs": { |
| "category": [ |
| "widgets" |
| ] |
| } |
| }</script><article id="progressbar1" class="entry widget"><h2 class="section-title"> |
| <span>Progressbar Widget</span><span class="version-details">version added: 1.6</span> |
| </h2> |
| <div class="entry-wrapper"> |
| <p class="desc"><strong>Description: </strong>Display status of a determinate process.</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-disabled">disabled</a></div> |
| <div><a href="#option-max">max</a></div> |
| <div><a href="#option-value">value</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-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-complete">complete</a></div> |
| <div><a href="#event-create">create</a></div> |
| </div></section><div class="longdesc" id="entry-longdesc"> |
| <p> |
| The progress bar is designed to display the current percent complete for a process. The bar is coded to be flexibly sized through CSS and will scale to fit inside its parent container by default. |
| </p> |
| <p> |
| This is a determinate progress bar, meaning that it should only be used in situations where the system can accurately update the current status. A determinate progress bar should never fill from left to right, then loop back to empty for a single process — if the actual status cannot be calculated, an indeterminate progress bar or spinner animation is a better way to provide user feedback. |
| </p> |
| |
| <h3>Dependencies</h3> |
| <ul> |
| <li><a href="/category/ui-core/">UI Core</a></li> |
| <li><a href="/jQuery.widget/">Widget Factory</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-disabled" class="api-item first-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 progressbar if set to <code>true</code>.</div> |
| <strong>Code examples:</strong><p>Initialize the progressbar 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> ).progressbar({ 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> ).progressbar( <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> ).progressbar( <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-max" class="api-item"> |
| <h3>max<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>0</code> |
| </div> |
| <div>The maximum value of the progressbar.</div> |
| <strong>Code examples:</strong><p>Initialize the progressbar 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> ).progressbar({ max: <span class="number">1024</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> ).progressbar( <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> ).progressbar( <span class="string">"option"</span>, <span class="string">"max"</span>, <span class="number">1024</span> );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| <div id="option-value" class="api-item"> |
| <h3>value<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>0</code> |
| </div> |
| <div>The value of the progressbar.</div> |
| <strong>Code examples:</strong><p>Initialize the progressbar with the <code>value</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> ).progressbar({ value: <span class="number">25</span> });</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <p>Get or set the <code>value</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> value = $( <span class="string">".selector"</span> ).progressbar( <span class="string">"option"</span>, <span class="string">"value"</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> ).progressbar( <span class="string">"option"</span>, <span class="string">"value"</span>, <span class="number">25</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 progressbar 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> ).progressbar( <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 progressbar. |
| </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> ).progressbar( <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 progressbar. |
| </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> ).progressbar( <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> ).progressbar( <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 progressbar 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> ).progressbar( <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 progressbar 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> ).progressbar( <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 progressbar.</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> ).progressbar( <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-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 of the progressbar.</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> progressSoFar = $( <span class="string">".selector"</span> ).progressbar( <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>Sets the current value of the progressbar.</div> |
| <ul><li> |
| <div><strong>value</strong></div> |
| <div>Type: <a href="http://api.jquery.com/Types/#Number">Number</a> |
| </div> |
| <div>The value 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> ).progressbar( <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 progressbar. |
| </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> ).progressbar( <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>progressbarchange</code></span> |
| </h3> |
| <div>Triggered when the value of the progressbar changes.</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 progressbar 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> ).progressbar({</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 progressbarchange 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">"progressbarchange"</span>, <span class="keyword">function</span>( event, ui ) {} );</code></div></div></pre> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| </div> |
| </div> |
| <div id="event-complete" class="api-item"> |
| <h3>complete( event, ui )<span class="returns">Type: <code>progressbarcomplete</code></span> |
| </h3> |
| <div>Triggered when the value of the progressbar reaches the maximum value.</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 progressbar with the complete 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> ).progressbar({</code></div></div><div class="container"><div class="line"><code> complete: <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 progressbarcomplete 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">"progressbarcomplete"</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>progressbarcreate</code></span> |
| </h3> |
| <div> |
| Triggered when the progressbar 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 progressbar 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> ).progressbar({</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 progressbarcreate 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">"progressbarcreate"</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">A simple jQuery UI Progressbar</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> |
| |
| </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>progressbar 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">div</span> <span class="attribute">id</span>=<span class="value">"progressbar"</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>$( <span class="string">"#progressbar"</span> ).progressbar({</code></div></div><div class="container"><div class="line"><code> value: <span class="number">37</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="50"></div> |
| </div></section> |
| </div></article> |
| |
| </body> |
| </html> |