Skip to content

Commit 00e4c6e

Browse files
kswedbergkswedberg
committed
Merge branch 'master' of github.com:jquery/api.jquery.com
* 'master' of github.com:jquery/api.jquery.com: Shuffle templates around to match UI. Removed <option> support, created includes for animation arguments.
2 parents 509a392 + 1ef8d39 commit 00e4c6e

16 files changed

Lines changed: 362 additions & 816 deletions

‎entries/animate.xml‎

Lines changed: 4 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,60 +7,18 @@
77
<argument name="properties" type="PlainObject">
88
<desc>A map of CSS properties that the animation will move toward.</desc>
99
</argument>
10-
<argument name="duration" type="Option"/>
11-
<argument name="easing" type="Option"/>
12-
<argument name="complete" type="Option"/>
10+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
11+
<xi:include href="../includes/easing-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
12+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
1313
</signature>
1414
<signature>
1515
<added>1.0</added>
1616
<argument name="properties" type="PlainObject">
1717
<desc>A map of CSS properties that the animation will move toward.</desc>
1818
</argument>
19-
<argument name="options" type="PlainObject">
20-
<desc>A map of additional options to pass to the method.</desc>
21-
</argument>
19+
<xi:include href="../includes/options-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
2220
</signature>
2321

24-
<options>
25-
<option name="duration" type="Number|String" default="400">
26-
<desc>A string or number determining how long the animation will run.</desc>
27-
</option>
28-
<option name="easing" type="String" default="swing">
29-
<desc>A string indicating which easing function to use for the transition.</desc>
30-
</option>
31-
<option name="complete" type="Function">
32-
<desc>A function to call once the animation is complete.</desc>
33-
<!-- no parameters -->
34-
</option>
35-
<option name="step" type="Function">
36-
<desc>A function to be called after each step of the animation.</desc>
37-
<argument name="now" type="Number">
38-
<desc>The numeric value of the property being animated at each step</desc>
39-
</argument>
40-
<argument name="fx" type="PlainObject">
41-
<desc>A map of properties related to the animation and the element being animated</desc>
42-
<property name="elem" type="DOM">
43-
<desc>The animated element</desc>
44-
</property>
45-
<property name="start" type="Number">
46-
<desc>The first value of the animated property</desc>
47-
</property>
48-
<property name="end" type="Number">
49-
<desc>The last value of the animated property</desc>
50-
</property>
51-
<property name="prop" type="String">
52-
<desc>The property being animated</desc>
53-
</property>
54-
</argument>
55-
</option>
56-
<option name="queue" type="Boolean" default="true">
57-
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
58-
</option>
59-
<option name="specialEasing" type="PlainObject">
60-
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).</desc>
61-
</option>
62-
</options>
63-
6422
<longdesc>
6523
<p>The <code>.animate()</code> method allows us to create animation effects on any numeric CSS property. The only required parameter is a map of CSS properties. This map is similar to the one that can be sent to the <code>.css()</code> method, except that the range of properties is more restrictive.</p>
6624
<h4 id="animation-properties">Animation Properties and Values</h4>

‎entries/fadeIn.xml‎

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,72 +4,20 @@
44
<desc>Display the matched elements by fading them to opaque.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="duration" type="String,Number" optional="true">
8-
<desc>A string or number determining how long the animation will run.</desc>
9-
</argument>
10-
<argument name="callback" type="Callback" optional="true">
11-
<desc>A function to call once the animation is complete.</desc>
12-
</argument>
7+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
8+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
139
</signature>
1410
<signature>
1511
<added>1.0</added>
16-
<argument name="options" type="PlainObject">
17-
<desc>A map of additional options to pass to the method.</desc>
18-
</argument>
12+
<xi:include href="../includes/options-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
1913
</signature>
2014
<signature>
2115
<added>1.4.3</added>
22-
<argument name="duration" type="String,Number" optional="true">
23-
<desc>A string or number determining how long the animation will run.</desc>
24-
</argument>
25-
<argument name="easing" type="String" optional="true">
26-
<desc>A string indicating which easing function to use for the transition.</desc>
27-
</argument>
28-
<argument name="callback" type="Callback" optional="true">
29-
<desc>A function to call once the animation is complete.</desc>
30-
</argument>
16+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
17+
<xi:include href="../includes/easing-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
18+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
3119
</signature>
3220

33-
<options>
34-
<option name="duration" type="Number|String" default="400">
35-
<desc>A string or number determining how long the animation will run.</desc>
36-
</option>
37-
<option name="easing" type="String" default="swing">
38-
<desc>A string indicating which easing function to use for the transition.</desc>
39-
</option>
40-
<option name="complete" type="Function">
41-
<desc>A function to call once the animation is complete.</desc>
42-
<!-- no parameters -->
43-
</option>
44-
<option name="step" type="Function">
45-
<desc>A function to be called after each step of the animation.</desc>
46-
<argument name="now" type="Number">
47-
<desc>The numeric value of the property being animated at each step</desc>
48-
</argument>
49-
<argument name="fx" type="PlainObject">
50-
<desc>A map of properties related to the animation and the element being animated</desc>
51-
<property name="elem" type="DOM">
52-
<desc>The animated element</desc>
53-
</property>
54-
<property name="start" type="Number">
55-
<desc>The first value of the animated property</desc>
56-
</property>
57-
<property name="end" type="Number">
58-
<desc>The last value of the animated property</desc>
59-
</property>
60-
<property name="prop" type="String">
61-
<desc>The property being animated</desc>
62-
</property>
63-
</argument>
64-
</option>
65-
<option name="queue" type="Boolean" default="true">
66-
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
67-
</option>
68-
<option name="specialEasing" type="PlainObject">
69-
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).</desc>
70-
</option>
71-
</options>
72-
7321
<longdesc>
7422
<p>The <code>.fadeIn()</code> method animates the opacity of the matched elements.</p>
7523
<p>Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings <code>'fast'</code> and <code>'slow'</code> can be supplied to indicate durations of <code>200</code> and <code>600</code> milliseconds, respectively. If any other string is supplied, or if the <code>duration</code> parameter is omitted, the default duration of <code>400</code> milliseconds is used.</p>

‎entries/fadeOut.xml‎

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,72 +4,20 @@
44
<desc>Hide the matched elements by fading them to transparent.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="duration" type="String,Number" optional="true">
8-
<desc>A string or number determining how long the animation will run.</desc>
9-
</argument>
10-
<argument name="callback" type="Callback" optional="true">
11-
<desc>A function to call once the animation is complete.</desc>
12-
</argument>
7+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
8+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
139
</signature>
1410
<signature>
1511
<added>1.0</added>
16-
<argument name="options" type="PlainObject">
17-
<desc>A map of additional options to pass to the method.</desc>
18-
</argument>
12+
<xi:include href="../includes/options-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
1913
</signature>
2014
<signature>
2115
<added>1.4.3</added>
22-
<argument name="duration" type="String,Number" optional="true">
23-
<desc>A string or number determining how long the animation will run.</desc>
24-
</argument>
25-
<argument name="easing" type="String" optional="true">
26-
<desc>A string indicating which easing function to use for the transition.</desc>
27-
</argument>
28-
<argument name="callback" type="Callback" optional="true">
29-
<desc>A function to call once the animation is complete.</desc>
30-
</argument>
16+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
17+
<xi:include href="../includes/easing-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
18+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
3119
</signature>
3220

33-
<options>
34-
<option name="duration" type="Number|String" default="400">
35-
<desc>A string or number determining how long the animation will run.</desc>
36-
</option>
37-
<option name="easing" type="String" default="swing">
38-
<desc>A string indicating which easing function to use for the transition.</desc>
39-
</option>
40-
<option name="complete" type="Function">
41-
<desc>A function to call once the animation is complete.</desc>
42-
<!-- no parameters -->
43-
</option>
44-
<option name="step" type="Function">
45-
<desc>A function to be called after each step of the animation.</desc>
46-
<argument name="now" type="Number">
47-
<desc>The numeric value of the property being animated at each step</desc>
48-
</argument>
49-
<argument name="fx" type="PlainObject">
50-
<desc>A map of properties related to the animation and the element being animated</desc>
51-
<property name="elem" type="DOM">
52-
<desc>The animated element</desc>
53-
</property>
54-
<property name="start" type="Number">
55-
<desc>The first value of the animated property</desc>
56-
</property>
57-
<property name="end" type="Number">
58-
<desc>The last value of the animated property</desc>
59-
</property>
60-
<property name="prop" type="String">
61-
<desc>The property being animated</desc>
62-
</property>
63-
</argument>
64-
</option>
65-
<option name="queue" type="Boolean" default="true">
66-
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
67-
</option>
68-
<option name="specialEasing" type="PlainObject">
69-
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).</desc>
70-
</option>
71-
</options>
72-
7321
<longdesc>
7422
<p>The <code>.fadeOut()</code> method animates the opacity of the matched elements. Once the opacity reaches 0, the <code>display</code> style property is set to <code>none</code>, so the element no longer affects the layout of the page.</p>
7523
<p>Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings <code>'fast'</code> and <code>'slow'</code> can be supplied to indicate durations of <code>200</code> and <code>600</code> milliseconds, respectively. If any other string is supplied, or if the <code>duration</code> parameter is omitted, the default duration of <code>400</code> milliseconds is used.</p>

‎entries/fadeToggle.xml‎

Lines changed: 4 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,63 +4,15 @@
44
<desc>Display or hide the matched elements by animating their opacity.</desc>
55
<signature>
66
<added>1.4.4</added>
7-
<argument name="duration" type="String,Number" optional="true">
8-
<desc>A string or number determining how long the animation will run.</desc>
9-
</argument>
10-
<argument name="easing" type="String" optional="true">
11-
<desc>A string indicating which easing function to use for the transition.</desc>
12-
</argument>
13-
<argument name="callback" type="Function" optional="true">
14-
<desc>A function to call once the animation is complete.</desc>
15-
</argument>
7+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
8+
<xi:include href="../includes/easing-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
9+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
1610
</signature>
1711
<signature>
1812
<added>1.4.4</added>
19-
<argument name="options" type="PlainObject">
20-
<desc>A map of additional options to pass to the method.</desc>
21-
</argument>
13+
<xi:include href="../includes/options-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
2214
</signature>
2315

24-
<options>
25-
<option name="duration" type="Number|String" default="400">
26-
<desc>A string or number determining how long the animation will run.</desc>
27-
</option>
28-
<option name="easing" type="String" default="swing">
29-
<desc>A string indicating which easing function to use for the transition.</desc>
30-
</option>
31-
<option name="complete" type="Function">
32-
<desc>A function to call once the animation is complete.</desc>
33-
<!-- no parameters -->
34-
</option>
35-
<option name="step" type="Function">
36-
<desc>A function to be called after each step of the animation.</desc>
37-
<argument name="now" type="Number">
38-
<desc>The numeric value of the property being animated at each step</desc>
39-
</argument>
40-
<argument name="fx" type="PlainObject">
41-
<desc>A map of properties related to the animation and the element being animated</desc>
42-
<property name="elem" type="DOM">
43-
<desc>The animated element</desc>
44-
</property>
45-
<property name="start" type="Number">
46-
<desc>The first value of the animated property</desc>
47-
</property>
48-
<property name="end" type="Number">
49-
<desc>The last value of the animated property</desc>
50-
</property>
51-
<property name="prop" type="String">
52-
<desc>The property being animated</desc>
53-
</property>
54-
</argument>
55-
</option>
56-
<option name="queue" type="Boolean" default="true">
57-
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
58-
</option>
59-
<option name="specialEasing" type="PlainObject">
60-
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).</desc>
61-
</option>
62-
</options>
63-
6416
<longdesc>
6517
<p>The <code>.fadeToggle()</code> method animates the opacity of the matched elements. When called on a visible element, the element's <code>display</code> style property is set to <code>none</code> once the opacity reaches 0, so the element no longer affects the layout of the page.</p>
6618
<p>Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings <code>'fast'</code> and <code>'slow'</code> can be supplied to indicate durations of <code>200</code> and <code>600</code> milliseconds, respectively.</p>

‎entries/hide.xml‎

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,72 +7,20 @@
77
</signature>
88
<signature>
99
<added>1.0</added>
10-
<argument name="duration" type="String,Number">
11-
<desc>A string or number determining how long the animation will run.</desc>
12-
</argument>
13-
<argument name="callback" type="Callback" optional="true">
14-
<desc>A function to call once the animation is complete.</desc>
15-
</argument>
10+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
11+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
1612
</signature>
1713
<signature>
1814
<added>1.0</added>
19-
<argument name="options" type="PlainObject">
20-
<desc>A map of additional options to pass to the method.</desc>
21-
</argument>
15+
<xi:include href="../includes/options-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
2216
</signature>
2317
<signature>
2418
<added>1.4.3</added>
25-
<argument name="duration" type="String|Number" optional="true">
26-
<desc>A string or number determining how long the animation will run.</desc>
27-
</argument>
28-
<argument name="easing" type="String" optional="true">
29-
<desc>A string indicating which easing function to use for the transition.</desc>
30-
</argument>
31-
<argument name="callback" type="Callback" optional="true">
32-
<desc>A function to call once the animation is complete.</desc>
33-
</argument>
19+
<xi:include href="../includes/duration-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
20+
<xi:include href="../includes/easing-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
21+
<xi:include href="../includes/complete-argument.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
3422
</signature>
3523

36-
<options>
37-
<option name="duration" type="Number|String" default="400">
38-
<desc>A string or number determining how long the animation will run.</desc>
39-
</option>
40-
<option name="easing" type="String" default="swing">
41-
<desc>A string indicating which easing function to use for the transition.</desc>
42-
</option>
43-
<option name="complete" type="Function">
44-
<desc>A function to call once the animation is complete.</desc>
45-
<!-- no parameters -->
46-
</option>
47-
<option name="step" type="Function">
48-
<desc>A function to be called after each step of the animation.</desc>
49-
<argument name="now" type="Number">
50-
<desc>The numeric value of the property being animated at each step</desc>
51-
</argument>
52-
<argument name="fx" type="PlainObject">
53-
<desc>A map of properties related to the animation and the element being animated</desc>
54-
<property name="elem" type="DOM">
55-
<desc>The animated element</desc>
56-
</property>
57-
<property name="start" type="Number">
58-
<desc>The first value of the animated property</desc>
59-
</property>
60-
<property name="end" type="Number">
61-
<desc>The last value of the animated property</desc>
62-
</property>
63-
<property name="prop" type="String">
64-
<desc>The property being animated</desc>
65-
</property>
66-
</argument>
67-
</option>
68-
<option name="queue" type="Boolean" default="true">
69-
<desc>A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. <strong>As of jQuery 1.7</strong>, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.</desc>
70-
</option>
71-
<option name="specialEasing" type="PlainObject">
72-
<desc>A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).</desc>
73-
</option>
74-
</options>
75-
7624
<longdesc>
7725
<p>With no parameters, the <code>.hide()</code> method is the simplest way to hide an element:</p>
7826
<pre><code>$('.target').hide();

0 commit comments

Comments
 (0)