Progressbar: Update with API changes and addition of indeterminate pr…

…ogressbar.
jquery · Jan 17, 2013 · 232ca61 · 232ca61
1 parent d681809
commit 232ca61
Showing 1 changed file with 29 additions and 6 deletions.
diff --git a/entries/progressbar.xml b/entries/progressbar.xml
@@ -1,13 +1,13 @@
 <?xml version="1.0"?>
 <entry name="progressbar" type="widget" widget-element="progressbar">
 	<title>Progressbar Widget</title>
-	<desc>Display status of a determinate process.</desc>
+	<desc>Display status of a determinate or indeterminate 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.
+			A determinate progress bar 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 should be used to provide user feedback.
 		</p>
 
 		<h3>Dependencies</h3>
@@ -20,12 +20,21 @@
 	<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">
+		<option name="max" default="100" 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" />
+			<type name="Number">
+				<desc>
+					A value between <code>0</code> and the <a href="#option-max"><code>max</code></a>.
+				</desc>
+			</type>
+			<type name="Boolean">
+				<desc>
+					Value can be set to <code>false</code> to create an indeterminate progressbar.
+				</desc>
+			</type>
 		</option>
 	</options>
 	<events>
@@ -53,8 +62,10 @@
 			</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 name="value">
+					<desc>The value to set. See the <a href="#option-value"><code>value</code></a> option for details on valid values.</desc>
+					<type name="Number"/>
+					<type name="Boolean"/>
 				</argument>
 			</signature>
 		</method>
@@ -70,6 +81,18 @@ $( "#progressbar" ).progressbar({
 ]]></code>
 		<html><![CDATA[
 <div id="progressbar"></div>
+]]></html>
+	</example>
+	<example>
+		<height>50</height>
+		<desc>A simple jQuery UI Indeterminate Progressbar</desc>
+		<code><![CDATA[
+$( "#progressbar" ).progressbar({
+	value: false
+});
+]]></code>
+		<html><![CDATA[
+<div id="progressbar"></div>
 ]]></html>
 	</example>
 	<category slug="widgets"/>