Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

77 lines (75 sloc) 3.2 kB
<?xml version="1.0"?>
<entry name="progressbar" type="widget" widget-element="progressbar">
<title>Progressbar Widget</title>
<desc>Display status of a determinate process.</desc>
<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 &#8212; 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>
</longdesc>
<note id="functional-css"/>
<added>1.6</added>
<options>
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<option name="max" default="0" type="Number" example-value="1024">
<desc>The maximum value of the progressbar.</desc>
</option>
<option name="value" default="0" example-value="25">
<desc>The value of the progressbar.</desc>
<type name="Number" />
</option>
</options>
<events>
<event name="change">
<desc>Triggered when the value of the progressbar changes.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object"/>
</event>
<xi:include href="../includes/widget-event-create.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<event name="complete">
<desc>Triggered when the value of the progressbar reaches the maximum value.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object"/>
</event>
</events>
<methods>
<xi:include href="../includes/widget-method-destroy.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/widget-method-disable.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/widget-method-enable.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/widget-method-option.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<method name="value">
<desc>Gets or sets the current value of the progressbar.</desc>
<signature return="Number" example-return-var="progressSoFar">
<desc>Gets the current value of the progressbar.</desc>
</signature>
<signature example-params='50'>
<desc>Sets the current value of the progressbar.</desc>
<argument name="value" type="Number">
<desc>The value to set.</desc>
</argument>
</signature>
</method>
<xi:include href="../includes/widget-method-widget.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</methods>
<example>
<height>50</height>
<desc>A simple jQuery UI Progressbar</desc>
<code><![CDATA[
$( "#progressbar" ).progressbar({
value: 37
});
]]></code>
<html><![CDATA[
<div id="progressbar"></div>
]]></html>
</example>
<category slug="widgets"/>
</entry>
Jump to Line
Something went wrong with that request. Please try again.