Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
68 lines (67 sloc) 2.83 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>
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.
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.
<note id="functional-css"/>
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi=""/>
<option name="value" default="0">
<desc>The value of the progressbar.</desc>
<type name="Number" />
<event name="change" type="progressbarchange">
<desc>Triggered when the value of the progressbar changes.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object"/>
<xi:include href="../includes/widget-event-create.xml" xmlns:xi=""/>
<event name="complete" type="progressbarcomplete">
<desc>Triggered when the value of the progressbar reaches the maximum value.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object"/>
<xi:include href="../includes/widget-method-destroy.xml" xmlns:xi=""/>
<xi:include href="../includes/widget-method-disable.xml" xmlns:xi=""/>
<xi:include href="../includes/widget-method-enable.xml" xmlns:xi=""/>
<xi:include href="../includes/widget-method-option.xml" xmlns:xi=""/>
<method name="value">
<desc>Gets or sets the current value of the progressbar.</desc>
<signature return="Number">
<desc>Gets the current value of the progressbar.</desc>
<desc>Sets the current value of the progressbar.</desc>
<argument name="value" type="Number">
<desc>The value to set.</desc>
<xi:include href="../includes/widget-method-widget.xml" xmlns:xi=""/>
<desc>A simple jQuery UI Progressbar</desc>
$( "#progressbar" ).progressbar({
value: 37
<div id="progressbar"></div>
<category slug="widgets"/>
Something went wrong with that request. Please try again.