Skip to content

Commit 43817cd

Browse files
committed
Spinner: Document that events are triggered when programmatically stepping. Fixes jquery#83.
1 parent 3902461 commit 43817cd

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

entries/spinner.xml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,33 +96,39 @@
9696
<xi:include href="../includes/widget-method-option.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
9797
<method name="pageDown">
9898
<desc>
99-
Decrements the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is decremented.
99+
<p>Decrements the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is decremented.</p>
100+
<p>If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value.</p>
101+
<p>Invoking <code>pageDown()</code> will cause <a href="#event-start"><code>start</code></a>, <a href="#event-spin"><code>spin</code></a>, and <a href="#event-stop"><code>stop</code></a> events to be triggered.</p>
100102
</desc>
101103
<argument name="pages" type="Number" optional="true">
102104
<desc>Number of pages to decrement, defaults to 1.</desc>
103105
</argument>
104106
</method>
105107
<method name="pageUp" example-params='10'>
106108
<desc>
107-
Increments the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is incremented.
109+
<p>Increments the value by the specified number of pages, as defined by the <a href="#option-page"><code>page</code></a> option. Without the parameter, a single page is incremented.</p>
110+
<p>If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value.</p>
111+
<p>Invoking <code>pageUp()</code> will cause <a href="#event-start"><code>start</code></a>, <a href="#event-spin"><code>spin</code></a>, and <a href="#event-stop"><code>stop</code></a> events to be triggered.</p>
108112
</desc>
109113
<argument name="pages" type="Number" optional="true">
110114
<desc>Number of pages to increment, defaults to 1.</desc>
111115
</argument>
112116
</method>
113117
<method name="stepDown">
114118
<desc>
115-
Decrements the value by the specified number of steps. Without the parameter, a single step is decremented.
116-
<p>If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.</p>
119+
<p>Decrements the value by the specified number of steps. Without the parameter, a single step is decremented.</p>
120+
<p>If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value.</p>
121+
<p>Invoking <code>stepDown()</code> will cause <a href="#event-start"><code>start</code></a>, <a href="#event-spin"><code>spin</code></a>, and <a href="#event-stop"><code>stop</code></a> events to be triggered.</p>
117122
</desc>
118123
<argument name="steps" type="Number" optional="true">
119124
<desc>Number of steps to decrement, defaults to 1.</desc>
120125
</argument>
121126
</method>
122127
<method name="stepUp" example-params='5'>
123128
<desc>
124-
Increments the value by the specified number of steps. Without the parameter, a single step is incremented.
125-
<p>If the resulting value is above the max, below the min, or reuslts in a step mismatch, the value will be adjusted to the closest valid value.</p>
129+
<p>Increments the value by the specified number of steps. Without the parameter, a single step is incremented.</p>
130+
<p>If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value.</p>
131+
<p>Invoking <code>stepUp()</code> will cause <a href="#event-start"><code>start</code></a>, <a href="#event-spin"><code>spin</code></a>, and <a href="#event-stop"><code>stop</code></a> events to be triggered.</p>
126132
</desc>
127133
<argument name="steps" type="Number" optional="true">
128134
<desc>Number of steps to increment, defaults to 1.</desc>

0 commit comments

Comments
 (0)