-
Notifications
You must be signed in to change notification settings - Fork 73
/
progressbar.xml
67 lines (67 loc) · 2.81 KB
/
progressbar.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?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 — if the actual status cannot be calculated, an indeterminate progress bar or spinner animation is a better way to provide user feedback.
</p>
</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="value" default="0">
<desc>The value of the progressbar.</desc>
<type name="Number" />
</option>
</options>
<events>
<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"/>
</event>
<xi:include href="../includes/widget-event-create.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<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"/>
</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>
<desc>Gets the current value of the progressbar.</desc>
</signature>
<signature>
<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>