Skip to content

Commit e918e9a

Browse files
committed
[fix]: Document theme classes as part of the Theming options
1 parent 4c9582f commit e918e9a

File tree

4 files changed

+18
-17
lines changed

4 files changed

+18
-17
lines changed

entries/accordion.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,13 @@
3939
<li>
4040
<code>ui-accordion</code>: The outer container of the accordion.
4141
<ul>
42-
<li><code>ui-accordion-header</code>: The headers of the accordion. The headers will additionally have a <code>ui-accordion-icons</code> class if they contain <a href="#option-icons"><code>icons</code></a>.</li>
43-
<li><code>ui-accordion-content</code>: The content panels of the accordion.</li>
42+
<li>
43+
<code>ui-accordion-header</code>: The headers of the accordion. The active header will additionally have a <code>ui-accordion-content-active</code> class, the inactive headers will have a <code>ui-accordion-header-collapsed</code> class. The headers will also have a <code>ui-accordion-icons</code> class if they contain <a href="#option-icons"><code>icons</code></a>.
44+
<ul>
45+
<li><code>ui-accordion-header-icon</code>: Icon elements within each accordion header.</li>
46+
</ul>
47+
</li>
48+
<li><code>ui-accordion-content</code>: The content panels of the accordion. The active content panel will additionally have a <code>ui-accordion-content-active</code> class.</li>
4449
</ul>
4550
</li>
4651
</ul>
@@ -88,14 +93,9 @@
8893
</option>
8994
<option name="classes" type="Object">
9095
<default>{
91-
"ui-accordion": undefined,
92-
"ui-accordion-icons": undefined,
93-
"ui-accordion-header-icon": undefined,
9496
"ui-accordion-header": "ui-corner-top",
95-
"ui-accordion-header-active": undefined,
9697
"ui-accordion-header-collapsed": "ui-corner-all",
97-
"ui-accordion-content": "ui-corner-bottom",
98-
"ui-accordion-content-active": undefined
98+
"ui-accordion-content": "ui-corner-bottom"
9999
}</default>
100100
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
101101
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>

entries/draggable.xml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
<longdesc>
66
<p>Make the selected elements draggable by mouse. If you want not just drag, but drag &amp; drop, see the <a href="/droppable/">jQuery UI Droppable plugin</a>, which provides a drop target for draggables.</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-draggable</code>: The draggable element. When the draggable is disabled, the <code>ui-draggable-disabled</code> class is added. While dragging, the <code>ui-draggable-dragging</code> class is added.</li>
12+
<li><code>ui-draggable-handle</code>: The handle of the draggable, specified using the <a href="#option-handle"><code>handle</code> option</a>. By default, the draggable element itself is also the handle.</li>
13+
</ul>
14+
815
<h3>Dependencies</h3>
916
<ul>
1017
<li><a href="/category/ui-core/">UI Core</a></li>
@@ -41,13 +48,7 @@
4148
<option name="cancel" type="Selector" default='"input,textarea,button,select,option"' example-value='".title"'>
4249
<desc>Prevents dragging from starting on specified elements.</desc>
4350
</option>
44-
<option name="classes" type="Object">
45-
<default>{
46-
"ui-draggable": undefined,
47-
"ui-draggable-disabled": undefined,
48-
"ui-draggable-dragging": undefined,
49-
"ui-draggable-handle": undefined
50-
}</default>
51+
<option name="classes" type="Object" default="{}">
5152
<xi:include href="../includes/classes-option-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
5253
<xi:include href="../includes/classes-option-example.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
5354
</option>

includes/classes-option-desc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<?xml version="1.0"?>
22
<desc>
3-
<p>Specify additional classes to add to the widget's elements. Any of the default keys can be specified to override their value. To learn more about this option, check out the <a href="http://learn.jquery.com/jquery-ui/widget-factory/classes-option/">learn article about the <code>classes</code> option</a>.</p>
3+
<p>Specify additional classes to add to the widget's elements. Any of classes specified in the <a href="#theming">Theming section</a> can be used as keys to override their value. To learn more about this option, check out the <a href="http://learn.jquery.com/jquery-ui/widget-factory/classes-option/">learn article about the <code>classes</code> option</a>.</p>
44
</desc>

includes/widget-theming.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
<div>
33
<h3 id="theming">Theming</h3>
44

5-
<p>The <placeholder name="name"/> widget uses the <a href="/theming/css-framework/">jQuery UI CSS framework</a> to style its look and feel. If <placeholder name="name"/> specific styling is needed, the following CSS class names can be used:</p>
5+
<p>The <placeholder name="name"/> widget uses the <a href="/theming/css-framework/">jQuery UI CSS framework</a> to style its look and feel. If <placeholder name="name"/> specific styling is needed, the following CSS class names can be used for overrides or as keys for the <a href="#option-classes"><code>classes</code> option</a>:</p>
66
</div>

0 commit comments

Comments
 (0)