Skip to content

Commit

Permalink
updated to latest 1.4.4 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mustardamus committed Nov 12, 2010
1 parent 5d42b52 commit 9ee9654
Show file tree
Hide file tree
Showing 35 changed files with 175 additions and 72 deletions.
5 changes: 3 additions & 2 deletions docs/animate/index.html
Expand Up @@ -48,7 +48,8 @@ <h4 class="name">
</ul>
<div class="longdesc">
<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>
<p>All animated properties should be numeric (except as noted below); properties that are non-numeric cannot be animated using basic jQuery functionality. (For example, <code>width</code>, <code>height</code>, or <code>left</code> can be animated but <code>background-color</code> cannot be.) Property values are treated as a number of pixels unless otherwise specified. The units <code>em</code> and <code>%</code> can be specified where applicable.</p>
<p>All animated properties should be a <em>single numeric value</em> (except as noted below); properties that are non-numeric cannot be animated using basic jQuery functionality. (For example, <code>width</code>, <code>height</code>, or <code>left</code> can be animated but <code>background-color</code> cannot be.) Property values are treated as a number of pixels unless otherwise specified. The units <code>em</code> and <code>%</code> can be specified where applicable.</p>
<p>Shorthand CSS properties (e.g. margin, background, border) are not supported. For example, if you want to retrieve the rendered margin, use: <code>$(elem).css('marginTop')</code> and <code>$(elem).css('marginRight')</code>, and so on.</p>
<p>In addition to numeric values, each property can take the strings <code>'show'</code>, <code>'hide'</code>, and <code>'toggle'</code>. These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.</p>
<p>Animated properties can also be relative. If a value is supplied with a leading <code>+=</code> or <code>-=</code> sequence of characters, then the target value is computed by adding or subtracting the given number from the current value of the property.</p>
<h4 id="duration">Duration</h4>
Expand Down Expand Up @@ -114,7 +115,7 @@ <h4 id="per-property-easing">Per-property Easing</h4>
<p>As previously noted, a plug-in is required for the <code>easeOutBounce</code> function.</p>
</div>
<h3 id="notes-0">Additional Notes:</h3>
<div class="longdesc"><ul><li>All jQuery effects, including <code>.animate()</code>, can be turned off globally by setting <code>jQuery.fx.off = true</code>. For more information, see <a href="http://api.jquery.com/jquery.fx.off">jQuery.fx.off</a>.</li></ul></div>
<div class="longdesc"><ul><li>All jQuery effects, including <code>.animate()</code>, can be turned off globally by setting <code>jQuery.fx.off = true</code>, which effectively sets the duration to 0. For more information, see <a href="http://api.jquery.com/jquery.fx.off">jQuery.fx.off</a>.</li></ul></div>
<h3>Examples:</h3>
<div class="entry-examples" id="entry-examples">
<div id="example-0">
Expand Down
8 changes: 4 additions & 4 deletions docs/attribute-contains-prefix-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Contains Prefix Selector [name|=value]</h1>
<h1 class="jq-clearfix">Attribute Contains Prefix Selector [name|="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,12 +14,12 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeContainsPrefix</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute|=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute|="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value either equal to a given string or starting with that string followed by a hyphen (-).</p>
<div class="longdesc"><p>This selector was introduced into the CSS specification to handle language attributes.</p></div>
Expand All @@ -37,7 +37,7 @@ <h4><span class="desc">Finds all links with an hreflang attribute that is englis

&lt;a href="example.html" hreflang="en-UK"&gt;Some other text&lt;/a&gt;

&lt;script&gt;$('a[hreflang|=en]').css('border','3px dotted green');&lt;/script&gt;
&lt;script&gt;$('a[hreflang|="en"]').css('border','3px dotted green');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
10 changes: 5 additions & 5 deletions docs/attribute-contains-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Contains Selector [name*=value]</h1>
<h1 class="jq-clearfix">Attribute Contains Selector [name*="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,15 +14,15 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeContains</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute*=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute*="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value containing the a given substring.</p>
<div class="longdesc"><p>This is the most generous of the jQuery attribute selectors that match against a value. It will select an element if the selector's string appears anywhere within the element's attribute value. Compare this selector with the Attribute Contains Word selector (e.g. [attr~=word]), which is more appropriate in many cases.</p></div>
<div class="longdesc"><p>This is the most generous of the jQuery attribute selectors that match against a value. It will select an element if the selector's string appears anywhere within the element's attribute value. Compare this selector with the Attribute Contains Word selector (e.g. [attr~="word"]), which is more appropriate in many cases.</p></div>
<h3>Example:</h3>
<div class="entry-examples" id="entry-examples"><div id="example-0">
<h4><span class="desc">Finds all inputs with a name attribute that contains 'man' and sets the value with some text.</span></h4>
Expand All @@ -37,7 +37,7 @@ <h4><span class="desc">Finds all inputs with a name attribute that contains 'man
&lt;input name="milkman" /&gt;
&lt;input name="letterman2" /&gt;
&lt;input name="newmilk" /&gt;
&lt;script&gt;$("input[name*='man']").val("has man in it!");&lt;/script&gt;
&lt;script&gt;$('input[name*="man"]').val('has man in it!');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
8 changes: 4 additions & 4 deletions docs/attribute-contains-word-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Contains Word Selector [name~=value]</h1>
<h1 class="jq-clearfix">Attribute Contains Word Selector [name~="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,12 +14,12 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeContainsWord</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute~=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute~="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value containing a given word, delimited by spaces.</p>
<div class="longdesc"><p>This selector matches the test string against each word in the attribute value, where a "word" is defined as a string delimited by whitespace. The selector matches if the test string is exactly equal to any of the words.</p></div>
Expand All @@ -37,7 +37,7 @@ <h4><span class="desc">Finds all inputs with a name attribute that contains the
&lt;input name="milk man" /&gt;
&lt;input name="letterman2" /&gt;
&lt;input name="newmilk" /&gt;
&lt;script&gt;$("input[name~=man]").val("mr. man is in it!");&lt;/script&gt;
&lt;script&gt;$('input[name~="man"]').val('mr. man is in it!');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
8 changes: 4 additions & 4 deletions docs/attribute-ends-with-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Ends With Selector [name$=value]</h1>
<h1 class="jq-clearfix">Attribute Ends With Selector [name$="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,12 +14,12 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeEndsWith</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute$=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute$="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value ending exactly with a given string. The comparison is case sensitive.</p>
<h3>Example:</h3>
Expand All @@ -35,7 +35,7 @@ <h4><span class="desc">Finds all inputs with an attribute name that ends with 'l

&lt;input name="milkman" /&gt;
&lt;input name="jobletter" /&gt;
&lt;script&gt;$("input[name$='letter']").val("a letter");&lt;/script&gt;
&lt;script&gt;$('input[name$="letter"]').val('a letter');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
8 changes: 4 additions & 4 deletions docs/attribute-equals-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Equals Selector [name=value]</h1>
<h1 class="jq-clearfix">Attribute Equals Selector [name="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,12 +14,12 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeEquals</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value exactly equal to a certain value.</p>
<h3>Example:</h3>
Expand Down Expand Up @@ -47,7 +47,7 @@ <h4><span class="desc">Finds all inputs with name 'newsletter' and changes the t

&lt;span&gt;name?&lt;/span&gt;
&lt;/div&gt;
&lt;script&gt;$("input[name='newsletter']").next().text(" is newsletter");&lt;/script&gt;
&lt;script&gt;$('input[name="newsletter"]').next().text(' is newsletter');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
10 changes: 5 additions & 5 deletions docs/attribute-not-equal-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Not Equal Selector [name!=value]</h1>
<h1 class="jq-clearfix">Attribute Not Equal Selector [name!="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,15 +14,15 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeNotEqual</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute!=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute!="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Select elements that either don't have the specified attribute, or do have the specified attribute but not with a certain value.</p>
<div class="longdesc"><p>This selector is equivalent to <code>:not([attr=value])</code>.</p></div>
<div class="longdesc"><p>This selector is equivalent to <code>:not([attr="value"])</code>.</p></div>
<h3>Example:</h3>
<div class="entry-examples" id="entry-examples"><div id="example-0">
<h4><span class="desc">Finds all inputs that don't have the name 'newsletter' and appends text to the span next to it.</span></h4>
Expand All @@ -48,7 +48,7 @@ <h4><span class="desc">Finds all inputs that don't have the name 'newsletter' an

&lt;span&gt;name is accept&lt;/span&gt;
&lt;/div&gt;
&lt;script&gt;$("input[name!=newsletter]").next().append("&lt;b&gt;; not newsletter&lt;/b&gt;");&lt;/script&gt;
&lt;script&gt;$('input[name!="newsletter"]').next().append('&lt;b&gt;; not newsletter&lt;/b&gt;');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
8 changes: 4 additions & 4 deletions docs/attribute-starts-with-selector/index.html
Expand Up @@ -3,7 +3,7 @@
<div class="entry-content">
<div class="entry-title roundTop">

<h1 class="jq-clearfix">Attribute Starts With Selector [name^=value]</h1>
<h1 class="jq-clearfix">Attribute Starts With Selector [name^="value"]</h1>
<div class="entry-meta">Categories:
<span class="category"><a href="http://api.jquery.com/category/selectors/" title="View all posts in Selectors">Selectors</a> &gt; <a href="http://api.jquery.com/category/selectors/attribute-selectors/" title="View all posts in Attribute">Attribute</a></span>

Expand All @@ -14,12 +14,12 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">attributeStartsWith</span> selector</h2>
<div class="jq-box roundBottom entry-details">
<h4 class="name">
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute^=value]')</h4>
<span class="versionAdded">version added: <a href="/version/1.0/">1.0</a></span>jQuery('[attribute^="value"]')</h4>
<ul class="signatures"><li><dl class="arguments">
<dt>attribute</dt>
<dd>An attribute name.</dd>
<dt>value</dt>
<dd>An attribute value. Quotes are optional.</dd>
<dd>An attribute value. Quotes are mandatory.</dd>
</dl></li></ul>
<p class="desc"><strong>Description: </strong>Selects elements that have the specified attribute with a value beginning exactly with a given string.</p>
<div class="longdesc"><p>This selector can be useful for identifying elements in pages produced by server-side frameworks that produce HTML with systematic element IDs. However it will be slower than using a class selector so leverage classes, if you can, to group like elements.</p></div>
Expand All @@ -36,7 +36,7 @@ <h4><span class="desc">Finds all inputs with an attribute name that starts with

&lt;input name="milkman" /&gt;
&lt;input name="newsboy" /&gt;
&lt;script&gt;$("input[name^='news']").val("news here!");&lt;/script&gt;
&lt;script&gt;$('input[name^="news"]').val('news here!');&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion docs/event.data/index.html
Expand Up @@ -14,7 +14,7 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">event.data</span> <span class="returns">Returns: <a class="return" href="http://docs.jquery.com/Types#Anything">Anything</a></span>
</h2>
<div class="jq-box roundBottom entry-details">
<p class="desc"><strong>Description: </strong> Contains the optional data passed to jQuery.fn.bind when the current executing handler was bound. </p>
<p class="desc"><strong>Description: </strong> The optional data passed to jQuery.fn.bind when the current executing handler was bound. </p>
<ul class="signatures"><li class="signature" id="event-data"><h4 class="name">
<span class="versionAdded">version added: <a href="/category/version/1.1/">1.1</a></span>event.data</h4></li></ul>
<h3>Example:</h3>
Expand Down
3 changes: 2 additions & 1 deletion docs/event.namespace/index.html
Expand Up @@ -14,9 +14,10 @@ <h2 class="jq-clearfix roundTop section-title">
<span class="name">event.namespace</span> <span class="returns">Returns: <a class="return" href="http://docs.jquery.com/Types#String">String</a></span>
</h2>
<div class="jq-box roundBottom entry-details">
<p class="desc"><strong>Description: </strong> This attribute contains the namespace specified when the event was triggered.</p>
<p class="desc"><strong>Description: </strong>The namespace specified when the event was triggered.</p>
<ul class="signatures"><li class="signature" id="event-namespace"><h4 class="name">
<span class="versionAdded">version added: <a href="/category/version/1.4.3/">1.4.3</a></span>event.namespace</h4></li></ul>
<div class="longdesc"><p>This will likely be used primarily by plugin authors who wish to handle tasks differently depending on the event namespace used.</p></div>
<h3>Example:</h3>
<div class="entry-examples" id="entry-examples"><div id="example-0">
<h4><span class="desc">Determine the event namespace used.</span></h4>
Expand Down

0 comments on commit 9ee9654

Please sign in to comment.