Permalink
Browse files

Document core methods and selectors.

  • Loading branch information...
scottgonzalez committed Aug 22, 2012
1 parent 15e3007 commit 412128d139896569bf7c110f687563497d9a98d3
View
@@ -16,14 +16,10 @@
]]>
</desc>
</category>
- <category name="Interactions" slug="interactions">
- <desc></desc>
- </category>
+ <category name="Interactions" slug="interactions"/>
<category name="Uncategorized" slug="uncategorized"/>
- <category name="Utilities" slug="utilities">
- <desc></desc>
- </category>
- <category name="Widgets" slug="widgets">
- <desc></desc>
- </category>
+ <category name="Utilities" slug="utilities"/>
+ <category name="Widgets" slug="widgets"/>
+ <category name="Methods" slug="methods"/>
+ <category name="Selectors" slug="selectors"/>
</categories>
View
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<entry type="selector" name="data" return="">
+ <title>:data() Selector</title>
+ <sample>:data(key)</sample>
+ <signature>
+ <argument name="key" type="String">
+ <desc>The data key.</desc>
+ </argument>
+ </signature>
+ <desc>Selects elements which have data stored under the specified key.</desc>
+ <longdesc>
+ <p>The expression <code>$( "div:data(foo)")</code> matches a <code>&lt;div&gt;</code> if it has data stored via <code>.data( "foo", value )</code>.</p>
+ </longdesc>
+ <category slug="selectors"/>
+</entry>
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<entry type="method" name="disableSelection" return="jQuery">
+ <title>.disableSelection()</title>
+ <desc>Disable selection of text content within the set of matched elements.</desc>
+ <deprecated>1.9</deprecated>
+ <signature/>
+ <longdesc>
+ <p>Disabled text selection is bad. Don't use this.</p>
+ </longdesc>
+ <category slug="methods"/>
+</entry>
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<entry type="method" name="enableSelection" return="jQuery">
+ <title>.enableSelection()</title>
+ <desc>Enable selection of text content within the set of matched elements.</desc>
+ <deprecated>1.9</deprecated>
+ <signature/>
+ <longdesc>
+ <p>The <code>.enableSelection()</code> method can be used to re-enable selection of text that was disabled via <a href="/disableSelection"><code>.disableSelection()</code></a>.</p>
+ </longdesc>
+ <category slug="methods"/>
+</entry>
View
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<entry type="method" name="focus" return="jQuery">
+ <title>.focus()</title>
+ <desc>Asynchronously set focus to an element.</desc>
+ <signature>
+ <argument name="delay" type="Number">
+ <desc>The number of milliseconds to wait before setting focus.</desc>
+ </argument>
+ <argument name="callback" type="Function" optional="true">
+ <desc>A function to invoke after the element has been focused.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>This signature is in addition to the <a href="http://api.jquery.com/focus">signatures provided by jQuery core</a>.</p>
+ </longdesc>
+ <category slug="methods"/>
+</entry>
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<entry type="selector" name="focusable" return="">
+ <title>:focusable() Selector</title>
+ <sample>:focusable</sample>
+ <signature/>
+ <desc>Selects elements which can be focused.</desc>
+ <category slug="selectors"/>
+</entry>
View
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<entry type="method" name="removeUniqueId" return="jQuery">
+ <title>.removeUniqueId()</title>
+ <desc>Remove ids that were set by <code>.uniqueId()</code> for the set of matched elements.</desc>
+ <signature/>
+ <longdesc>
+ <p>The <code>.removeUniqueId()</code> will remove ids that were set by <a href="/uniqueId"><code>.uniqueId()</code></a>.</p>
+ </longdesc>
+ <category slug="methods"/>
+</entry>
View
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<entry type="method" name="scrollParent" return="jQuery">
+ <title>.scrollParent()</title>
+ <desc>Get the closest ancestor element that is scrollable.</desc>
+ <signature/>
+ <category slug="methods"/>
+</entry>
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<entry type="selector" name="tabbable" return="">
+ <title>:tabbable() Selector</title>
+ <sample>:tabbable</sample>
+ <signature/>
+ <desc>Selects elements which the user can focus via tabbing.</desc>
+ <category slug="selectors"/>
+</entry>
View
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<entry type="method" name="uniqueId" return="jQuery">
+ <title>.uniqueId()</title>
+ <desc>Generate and apply a unique id for the set of matched elements.</desc>
+ <signature/>
+ <longdesc>
+ <p>Many widgets need to generate unique ids for elements. <code>.uniqueId()</code> will check if the element has an id, and if not, it will generate one and set it on the element. It is safe to call <code>.uniqueId()</code> on an element without checking if it already has an id. If/when the widget needs to clean up after itself, the <a href="/removeUniqueId"><code>.removeUniqueId()</code></a> method will remove the id from the element if it was added by <code>.uniqueId()</code> and leave the id alone if it was not. <code>.removeUniqueId()</code> is able to be smart about this because the generated ids have a prefix of <code>"ui-id-"</code>.</p>
+ </longdesc>
+ <category slug="methods"/>
+</entry>
View
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<entries>
+ <entry type="method" name="zIndex" return="jQuery">
+ <title>.zIndex()</title>
+ <desc>Get the z-index for an element.</desc>
+ <signature/>
+ <longdesc>
+ <p>The <code>.zIndex()</code> method is useful for finding the z-index of an element, regardless of whether the z-index is set directly on the element or on one of its ancestors. In order to determine the z-index, this method will start at the specified element and walk up the DOM until it finds an element that is positioned and has a z-index set. If no such element is found, then the method will return a value of <code>0</code>.</p>
+ <p>This method assumes that elements with nested z-indexes would not have a z-index of <code>0</code>. For example, given the following DOM the inner element will be treated as if it does not have a z-index set because it is impossible to differentiate between an explicit value of <code>0</code> and no value in Internet Explorer.</p>
+ <pre><code>
+ &lt;div style="z-index: -10;">
+ &lt;div style="z-index: 0;">&lt;/div>
+ &lt;/div>
+ </code></pre>
+ </longdesc>
+ <category slug="methods"/>
+ </entry>
+ <entry type="method" name="zIndex" return="Number">
+ <title>.zIndex()</title>
+ <desc>Set the z-index for an element.</desc>
+ <signature>
+ <argument name="zIndex" type="Number">
+ <desc>The z-index to set.</desc>
+ </argument>
+ </signature>
+ <longdesc>
+ <p>This is equivalent to <code>.css( "zIndex", zIndex )</code>.</p>
+ </longdesc>
+ <category slug="methods"/>
+ </entry>
+</entries>

0 comments on commit 412128d

Please sign in to comment.