Skip to content

Commit e26078b

Browse files
committed
Theming: Add a list of the icons jQuery UI provides. Fixes #135
(cherry picked from commit 624fccac348124a2252501ee5b24a2526b63eb89)
1 parent 1ea1ec5 commit e26078b

File tree

6 files changed

+774
-4
lines changed

6 files changed

+774
-4
lines changed

entries/accordion.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
</option>
9999
<option name="icons" type="Object" default='{ "header": "ui-icon-triangle-1-e", "activeHeader": "ui-icon-triangle-1-s" }' example-value='{ "header": "ui-icon-plus", "activeHeader": "ui-icon-minus" }'>
100100
<desc>
101-
<p>Icons to use for headers, matching an icon defined by the jQuery UI CSS Framework. Set to <code>false</code> to have no icons displayed.</p>
101+
<p>Icons to use for headers, matching <a href="/theming/icons/">an icon provided by the jQuery UI CSS Framework</a>. Set to <code>false</code> to have no icons displayed.</p>
102102
<ul>
103103
<li>header (string, default: "ui-icon-triangle-1-e")</li>
104104
<li>activeHeader (string, default: "ui-icon-triangle-1-s")</li>

entries/button.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@
2222
<options>
2323
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
2424
<option name="icons" default="{ primary: null, secondary: null }" example-value='{ primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }'>
25-
<desc>Icons to display, with or without text (see <a href="#option-text"><code>text</code></a> option). By default, the primary icon is displayed on the left of the label text and the secondary is displayed on the right. The positioning can be controlled via CSS. The value for the <code>primary</code> and <code>secondary</code> properties must be a class name, e.g., <code>"ui-icon-gear"</code>. For using only one icon: <code>icons: { primary: "ui-icon-locked" }</code>. For using two icons: <code>icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }</code>.</desc>
25+
<desc>
26+
<p>Icons to display, with or without text (see <a href="#option-text"><code>text</code></a> option). By default, the primary icon is displayed on the left of the label text and the secondary is displayed on the right. The positioning can be controlled via CSS.</p>
27+
28+
<p>The value for the <code>primary</code> and <code>secondary</code> properties must match <a href="/theming/icons/">an icon class name</a>, e.g., <code>"ui-icon-gear"</code>. For using only one icon: <code>icons: { primary: "ui-icon-locked" }</code>. For using two icons: <code>icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }</code>.</p>
29+
</desc>
2630
<type name="Object" />
2731
</option>
2832
<option name="label" default="null" example-value='"custom label"'>

entries/menu.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
6767
<option name="icons" type="Object" default='{ submenu: "ui-icon-carat-1-e" }' example-value='{ submenu: "ui-icon-circle-triangle-e" }'>
6868
<desc>
69-
Icons to use for submenus, matching an icon defined by the jQuery UI CSS Framework.
69+
Icons to use for submenus, matching <a href="/theming/icons/">an icon provided by the jQuery UI CSS Framework</a>.
7070
<ul>
7171
<li>submenu (string, default: "ui-icon-carat-1-e")</li>
7272
</ul>

entries/spinner.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
4242
<option name="icons" type="Object" default='{ down: "ui-icon-triangle-1-s", up: "ui-icon-triangle-1-n" }' example-value='{ down: "custom-down-icon", up: "custom-up-icon" }'>
4343
<desc>
44-
Icons to use for buttons, matching an icon defined by the jQuery UI CSS Framework.
44+
Icons to use for buttons, matching <a href="/theming/icons/">an icon provided by the jQuery UI CSS Framework</a>.
4545
<ul>
4646
<li>up (string, default: "ui-icon-triangle-1-n")</li>
4747
<li>down (string, default: "ui-icon-triangle-1-s")</li>

pages/theming/icons.html

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<script>{
2+
"title": "Icons",
3+
"excerpt": "A list of the icons provided by jQuery UI.",
4+
"termSlugs": {
5+
"category": [ "theming" ]
6+
}
7+
}</script>
8+
9+
<p>jQuery UI provides a number of icons that can be used by applying class names to elements. The class names generally follow a syntax of <code>.ui-icon-{icon type}-{icon sub description}-{direction}</code>. For example, the following will display an icon of a thick arrow pointing north:</p>
10+
11+
<pre><code>
12+
<span class="ui-icon ui-icon-arrowthick-1-n"></span>
13+
</code></pre>
14+
15+
<p>The icons are also integrated into a number of jQuery UI's widgets, such as <a href="/accordion/#option-icons">accordion</a>, <a href="/button/#option-icons">button</a>, <a href="/menu/#option-icons">menu</a>.
16+
17+
<p>The following is a full list of the icons provided:</p>
18+
19+
<iframe src="/resources/icons-list.html" width="100%" height="1000"></iframe>

0 commit comments

Comments
 (0)