Skip to content

Commit 7ce635f

Browse files
jzaeffererjzaefferer
committed
[fix]: Document classes option and theming for remaining components
1 parent 3d56060 commit 7ce635f

File tree

8 files changed

+116
-5
lines changed

8 files changed

+116
-5
lines changed

‎entries/resizable.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
<longdesc>
66
<p>The jQuery UI Resizable plugin makes selected elements resizable (meaning they have draggable resize handles). You can specify one or more handles as well as min and max width and height.</p>
77

8+
<xi:include href="../includes/widget-theming.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
9+
10+
<ul>
11+
<li><code>ui-resizable</code>: The resizable element. During a resize, the <code>ui-resizable-resizing</code> class is added. When the <a href="#option-autoHide"><code>autoHide</code> option</a> is set, this <code>ui-resizable-autohide</code> class is added.</li>
12+
<li><code>ui-resizable-handle</code>: One of the handles of the resizable, specified using the <a href="#option-handles"><code>handles</code> option</a>. Each handle will also have a <code>ui-resizable-{direction}</code> class according to their position.</li>
13+
<li><code>ui-resizable-ghost</code>: When using the <a href="#option-ghost"><code>ghost</code> option</a>, this class is applied to the ghost helper element.</li>
14+
<li><code>ui-resizable-helper</code>: When the <a href="#option-animate"><code>animate</code> option</a> is used, but the <a href="#option-helper"><code>helper</code> option</a> isn't specified, this class is added to the generated helper.</li>
15+
</ul>
16+
817
<h3>Dependencies</h3>
918
<ul>
1019
<li><a href="/category/ui-core/">UI Core</a></li>
@@ -63,6 +72,13 @@
6372
<desc>Possible values: <code>"parent"</code> and <code>"document"</code>.</desc>
6473
</type>
6574
</option>
75+
<option name="classes" type="Object">
76+
<default>{
77+
"ui-resizable-se": "ui-icon ui-icon-gripsmall-diagonal-se"
78+
}</default>
79+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
80+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
81+
</option>
6682
<option name="delay" type="Number" default="0" example-value='150'>
6783
<desc>Tolerance, in milliseconds, for when resizing should start. If specified, resizing will not start until after mouse is moved beyond duration. This can help prevent unintended resizing when clicking on an element.</desc>
6884
</option>

‎entries/selectable.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
<longdesc>
66
<p>The jQuery UI Selectable plugin allows for elements to be selected by dragging a box (sometimes called a lasso) with the mouse over the elements. Elements can also be selected via click or drag while holding the ctrl/meta key, allowing for multiple (non-contiguous) selections.</p>
77

8+
<xi:include href="../includes/widget-theming.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
9+
10+
<ul>
11+
<li><code>ui-selectable</code>: The selectable element.</li>
12+
<li><code>ui-selectable-helper</code>: The "lasso" element used to visualize the ongoing selection.</li>
13+
<li><code>ui-selectee</code>: One of the selectable elements, as specified through the <a href="#option-filter"><code>filter</code> option</a>. This element can also receive one of the following classes: <code>ui-selecting</code> (when the lasso includes this element), <code>ui-selected</code> (after a successful selection), <code>ui-unselecting</code> (when the lasso lost this element).</li>
14+
</ul>
15+
816
<h3>Dependencies</h3>
917
<ul>
1018
<li><a href="/category/ui-core/">UI Core</a></li>
@@ -24,6 +32,10 @@
2432
<option name="cancel" type="Selector" default='"input,textarea,button,select,option"' example-value='"a,.cancel"'>
2533
<desc>Prevents selecting if you start on elements matching the selector.</desc>
2634
</option>
35+
<option name="classes" type="Object" default="{}">
36+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
37+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
38+
</option>
2739
<option name="delay" type="Integer" default="0" example-value='150'>
2840
<desc>Time in milliseconds to define when the selecting should start. This helps prevent unwanted selections when clicking on an element.</desc>
2941
</option>

‎entries/selectmenu.xml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,48 @@
3333
<li><code>ALT</code>/<code>OPTION</code> + <code>UP</code>/<code>DOWN</code>: Toggle the visibility of the menu.</li>
3434
<li><code>SPACE</code>: Open the menu.</li>
3535
</ul>
36+
37+
<xi:include href="../includes/widget-theming.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
38+
39+
<ul>
40+
<li>
41+
<code>ui-selectmenu-button</code>: The button-like element replacing the native selectmenu on the page. Has the <code>ui-selectmenu-button-closed</code> class when closed, the <code>ui-selectmenu-button-open</code> class when open.
42+
<ul>
43+
<li><code>ui-selectmenu-text</code>: The span representing the text portion of the button element.</li>
44+
<li><code>ui-selectmenu-icon-space</code>: A supporting element between the text and the icon of the selectmenu button.</li>
45+
</ul>
46+
</li>
47+
<li>
48+
<code>ui-selectmenu-menu</code>: The wrapper element around the <a href="/menu/#theming">menu</a> used to display options to the user (not the menu itself). When the menu is open, the <code>ui-selectmenu-open</code> class is added.
49+
<ul>
50+
<li><code>ui-selectmenu-optgroup</code>: One of the elements that replicates <code>&lt;optgroup&gt;</code> elements from native selects.</li>
51+
</ul>
52+
</li>
53+
54+
</ul>
55+
56+
<h3>Dependencies</h3>
57+
<ul>
58+
<li><a href="/category/ui-core/">UI Core</a></li>
59+
<li><a href="/jQuery.widget/">Widget Factory</a></li>
60+
<li><a href="/position/">Position</a></li>
61+
<li><a href="/menu/">Menu</a></li>
62+
</ul>
3663
</longdesc>
3764
<note id="functional-css"/>
3865
<added>1.11</added>
3966
<options>
4067
<option name="appendTo" type="Selector" default="null" example-value='"#someElem"'>
4168
<desc>Which element to append the menu to. When the value is <code>null</code>, the parents of the <code>&lt;select&gt;</code> are checked for a class name of <code>ui-front</code>. If an element with the <code>ui-front</code> class name is found, the menu is appended to that element. Regardless of the value, if no element is found, the menu is appended to the body.</desc>
4269
</option>
70+
<option name="classes" type="Object">
71+
<default>{
72+
"ui-selectmenu-button-closed": "ui-corner-all",
73+
"ui-selectmenu-button-open": "ui-corner-top",
74+
}</default>
75+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
76+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
77+
</option>
4378
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
4479
<option name="icons" type="Object" default='{ button: "ui-icon-triangle-1-s" }' example-value='{ button: "ui-icon-circle-triangle-s" }'>
4580
<desc>

‎entries/slider.xml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
<ul>
1313
<li>
14-
<code>ui-slider</code>: The track of the slider control. This element will additionally have a class name of <code>ui-slider-horizontal</code> or <code>ui-slider-vertical</code> depending on the <a href="#option-orientation"><code>orientation</code></a> of the slider.
14+
<code>ui-slider</code>: The track of the slider control. This element will additionally have a class name of <code>ui-slider-horizontal</code> or <code>ui-slider-vertical</code> depending on the <a href="#option-orientation"><code>orientation</code> option</a> of the slider.
1515
<ul>
16-
<li><code>ui-slider-handle</code>: The slider handles.</li>
17-
<li><code>ui-slider-range</code>: The selected range used when the <a href="#option-range"><code>range</code></a> option is set. This element can additionally have a class of <code>ui-slider-range-min</code> or <code>ui-slider-range-max</code> if the <code>range</code> option is set to <code>"min"</code> or <code>"max"</code> respectively.</li>
16+
<li><code>ui-slider-handle</code>: One of the slider handles.</li>
17+
<li><code>ui-slider-range</code>: The selected range used when the <a href="#option-range"><code>range</code> option</a> is set. This element can additionally have a class of <code>ui-slider-range-min</code> or <code>ui-slider-range-max</code> if the <code>range</code> option is set to <code>"min"</code> or <code>"max"</code> respectively.</li>
1818
</ul>
1919
</li>
2020
</ul>
@@ -41,6 +41,15 @@
4141
<desc>The duration of the animation, in milliseconds.</desc>
4242
</type>
4343
</option>
44+
<option name="classes" type="Object">
45+
<default>{
46+
"ui-slider": "ui-corner-all",
47+
"ui-slider-handle": "ui-corner-all",
48+
"ui-slider-range": "ui-corner-all ui-widget-header",
49+
}</default>
50+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
51+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
52+
</option>
4453
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
4554
<option name="max" type="Number" default="100" example-value='50'>
4655
<desc>The maximum value of the slider.</desc>

‎entries/sortable.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66
<p>The jQuery UI Sortable plugin makes selected elements sortable by dragging with the mouse.</p>
77
<p><em>Note: In order to sort table rows, the <code>tbody</code> must be made sortable, not the <code>table</code>.</em></p>
88

9+
<xi:include href="../includes/widget-theming.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
10+
11+
<ul>
12+
<li><code>ui-sortable</code>: The sortable element.</li>
13+
<li><code>ui-sortable-handle</code>: The handle of each sortable item, specified using the <a href="#option-handle"><code>handle</code> option</a>. By default, each sortable item itself is also the handle.</li>
14+
<li><code>ui-sortable-helper</code>: The element shown while dragging a sortable item. The element actually used depends on the <a href="#option-helper"><code>helper</code> option</a>.</li>
15+
<li><code>ui-sortable-placeholder</code>: The element used to show the future position of the item currently being sorted.</li>
16+
</ul>
17+
918
<h3>Dependencies</h3>
1019
<ul>
1120
<li><a href="/category/ui-core/">UI Core</a></li>
@@ -36,6 +45,10 @@
3645
<option name="cancel" type="Selector" default='"input,textarea,button,select,option"' example-value='"a,button"'>
3746
<desc>Prevents sorting if you start on elements matching the selector.</desc>
3847
</option>
48+
<option name="classes" type="Object" default="{}">
49+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
50+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
51+
</option>
3952
<option name="connectWith" type="Selector" default='false' example-value='"#shopping-cart"'>
4053
<desc>A selector of other sortable elements that the items from this list should be connected to. This is a one-way relationship, if you want the items to be connected in both directions, the <code>connectWith</code> option must be set on both sortable elements.</desc>
4154
</option>

‎entries/spinner.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@
4949
</note>
5050
<added>1.9</added>
5151
<options>
52+
<option name="classes" type="Object">
53+
<default>{
54+
"ui-spinner": "ui-corner-all",
55+
"ui-spinner-down": "ui-corner-br",
56+
"ui-spinner-up": "ui-corner-tr"
57+
}</default>
58+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
59+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
60+
</option>
5261
<option name="culture" type="String" default="null" example-value='"fr"'>
5362
<desc>Sets the culture to use for parsing and formatting the value. If <code>null</code>, the currently set culture in <code>Globalize</code> is used, see <a href="https://github.com/jquery/globalize">Globalize docs</a> for available cultures. Only relevant if the <a href="#option-numberFormat"><code>numberFormat</code></a> option is set. Requires <a href="https://github.com/jquery/globalize">Globalize</a> to be included.</desc>
5463
</option>

‎entries/tabs.xml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@
6363

6464
<ul>
6565
<li>
66-
<code>ui-tabs</code>: The outer container of the tabs. This element will additionally have a class of <code>ui-tabs-collapsible</code> when the <a href="#option-collapsible"><code>collapsible</code></a> option is set.
66+
<code>ui-tabs</code>: The outer container of the tabs. This element will additionally have a class of <code>ui-tabs-collapsible</code> when the <a href="#option-collapsible"><code>collapsible</code> option</a> is set.
6767
<ul>
6868
<li>
6969
<code>ui-tabs-nav</code>: The list of tabs.
7070
<ul>
71-
<li>The active list item in the nav will have a <code>ui-tabs-active</code> class. Any list item whose associated content is loading via an Ajax call will have a <code>ui-tabs-loading</code> class.
71+
<li><code>ui-tabs-tab</code>: One of the items in the list of tabs.The active item will have the <code>ui-tabs-active</code> class. Any list item whose associated content is loading via an Ajax call will have the <code>ui-tabs-loading</code> class.
7272
<ul>
7373
<li><code>ui-tabs-anchor</code>: The anchors used to switch panels.</li>
7474
</ul>
@@ -101,6 +101,16 @@
101101
<desc>The zero-based index of the panel that is active (open). A negative value selects panels going backward from the last panel.</desc>
102102
</type>
103103
</option>
104+
<option name="classes" type="Object">
105+
<default>{
106+
"ui-tabs": "ui-corner-all",
107+
"ui-tabs-nav": "ui-corner-all",
108+
"ui-tabs-tab": "ui-corner-top",
109+
"ui-tabs-panel": "ui-corner-bottom"
110+
}</default>
111+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
112+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
113+
</option>
104114
<option name="collapsible" type="Boolean" default="false" example-value="true">
105115
<desc>When set to <code>true</code>, the active panel can be closed.</desc>
106116
</option>

‎entries/tooltip.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@
4040
<note id="functional-css"/>
4141
<added>1.9</added>
4242
<options>
43+
<option name="classes" type="Object">
44+
<default>{
45+
"ui-tooltip": "ui-corner-all ui-widget-shadow"
46+
}</default>
47+
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
48+
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
49+
</option>
4350
<option name="content" default="function returning the title attribute" example-value='"Awesome title!"'>
4451
<desc>
4552
<p>The content of the tooltip.</p>

0 commit comments

Comments
 (0)