Skip to content

Added options examples #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Added options examples #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8394f03
Added events in the datepicker api docs
shahraship Oct 15, 2012
07ac72d
Edited accordion beforeactivate event description
shahraship Oct 15, 2012
fe8b8e0
Added example values
shahraship Oct 16, 2012
85de68a
Changed hide/show and format update
shahraship Oct 16, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions entries/accordion.xml
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<note id="functional-css"/>
<added>1.0</added>
<options>
<option name="active" default="0">
<option name="active" default="0" example-value="2">
<desc>
Which panel is currently open.
</desc>
Expand All @@ -47,7 +47,7 @@
<desc>The zero-based index of the panel that is active (open). A negative value selects panels going backward from the last panel.</desc>
</type>
</option>
<option name="animate" default="{}">
<option name="animate" default="{}" example-value="'bounceslide'">
<desc>If and how to animate changing panels.</desc>
<type name="Boolean">
<desc>A value of <code>false</code> will disable animations.</desc>
Expand All @@ -67,19 +67,19 @@
</desc>
</type>
</option>
<option name="collapsible" type="Boolean" default="false">
<option name="collapsible" type="Boolean" default="false" example-value="true">
<desc>Whether all the sections can be closed at once. Allows collapsing the active section.</desc>
</option>
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<option name="event" type="String" default='"click"'>
<option name="event" type="String" default='"click"' example-value="'mouseover'">
<desc>The event that accordion headers will react to in order to activate the associated panel. Multiple events can be specificed, separated by a space.</desc>
</option>
<option name="header" type="Selector" default='"> li > :first-child,> :not(li):even"'>
<option name="header" type="Selector" default='"> li > :first-child,> :not(li):even"' example-value="'h3'">
<desc>
<p>Selector for the header element, applied via <code>.find()</code> on the main accordion element. Content panels must be the sibling immedately after their associated headers.</p>
</desc>
</option>
<option name="heightStyle" type="String" default='"auto"'>
<option name="heightStyle" type="String" default='"auto"' example-value="'fill'">
<desc>
<p>Controls the height of the accordion and each panel. Possible values:</p>
<ul>
Expand All @@ -89,7 +89,7 @@
</ul>
</desc>
</option>
<option name="icons" type="Object" default='{ "header": "ui-icon-triangle-1-e", "activeHeader": "ui-icon-triangle-1-s" }'>
<option name="icons" type="Object" default='{ "header": "ui-icon-triangle-1-e", "activeHeader": "ui-icon-triangle-1-s" }' example-value='{ "header": "ui-icon-plus", "headerSelected": "ui-icon-minus" }'>
<desc>
<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>
<ul>
Expand Down Expand Up @@ -119,7 +119,7 @@
</argument>
</event>
<event name="beforeActivate" type="accordionbeforeactivate">
<desc>Triggered directly after a panel is activated. Can be canceled to prevent the panel from activating. If the accordion is currently collapsed, <code>ui.oldHeader</code> and <code>ui.oldPanel</code> will be empty jQuery objects. If the accordion is collapsing, <code>ui.newHeader</code> and <code>ui.newPanel</code> will be empty jQuery objects.</desc>
<desc>Triggered directly before a panel is activated. Can be canceled to prevent the panel from activating. If the accordion is currently collapsed, <code>ui.oldHeader</code> and <code>ui.oldPanel</code> will be empty jQuery objects. If the accordion is collapsing, <code>ui.newHeader</code> and <code>ui.newPanel</code> will be empty jQuery objects.</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
<property name="newHeader" type="jQuery">
Expand Down
12 changes: 6 additions & 6 deletions entries/autocomplete.xml
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@
<note id="functional-css"/>
<added>1.8</added>
<options>
<option name="appendTo" type="Selector" default='"body"'>
<option name="appendTo" type="Selector" default='"body"' example-value='"#someElem"'>
<desc>Which element the menu should be appended to. Override this when the autocomplete is inside a <code>position: fixed</code> element. Otherwise the popup menu would still scroll with the page.</desc>
</option>
<option name="autoFocus" type="Boolean" default="false">
<option name="autoFocus" type="Boolean" default="false" example-value="true">
<desc>If set to <code>true</code> the first item will automatically be focused when the menu is shown.</desc>
</option>
<option name="delay" type="Integer" default="300">
<option name="delay" type="Integer" default="300" example-value='300'>
<desc>The delay in milliseconds between when a keystroke occurs and when a search is performed. A zero-delay makes sense for local data (more responsive), but can produce a lot of load for remote data, while being less responsive.</desc>
</option>
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<option name="minLength" type="Integer" default="1">
<option name="minLength" type="Integer" default="1" example-value='0'>
<desc>The minimum number of characters a user must type before a search is performed. Zero is useful for local data with just a few items, but a higher value should be used when a single character search could match a few thousand items.</desc>
</option>
<option name="position" type="Object" default='{ my: "left top", at: "left bottom", collision: "none" }'>
<option name="position" type="Object" default='{ my: "left top", at: "left bottom", collision: "none" }' example-value='{ my : "right top", at: "right bottom" }'>
<desc>Identifies the position of the suggestions menu in relation to the associated input element. The <code>of</code> option defaults to the input element, but you can specify another element to position against. You can refer to the <a href="/position">jQuery UI Position</a> utility for more details about the various options.</desc>
</option>
<option name="source" default="none; must be specified">
<option name="source" default="none; must be specified" example-value='["c++", "java", "php", "coldfusion", "javascript", "asp", "ruby"]'>
<desc>
Defines the data to use, must be specified.
<p>Independent of the variant you use, the label is always treated as text. If you want the label to be treated as html you can use <a href="https://github.com/scottgonzalez/jquery-ui-extensions/blob/master/autocomplete/jquery.ui.autocomplete.html.js">Scott González' html extension</a>. The demos all focus on different variations of the <code>source</code> option - look for one that matches your use case, and check out the code.</p>
Expand Down
6 changes: 3 additions & 3 deletions entries/button.xml
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
<added>1.8</added>
<options>
<xi:include href="../includes/widget-option-disabled.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<option name="icons" default="{ primary: null, secondary: null }">
<option name="icons" default="{ primary: null, secondary: null }" example-value="{primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}">
<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>
<type name="Object" />
</option>
<option name="label" default="null">
<option name="label" default="null" example-value='"custom label"'>
<desc>Text to show in the button. When not specified (<code>null</code>), the element's HTML content is used, or its <code>value</code> attribute if the element is an input element of type submit or reset, or the HTML content of the associated label element if the element is an input of type radio or checkbox.</desc>
<type name="String" />
</option>
<option name="text" default="true">
<option name="text" default="true" example-value='false'>
<desc>Whether to show the label. When set to <code>false</code> no text will be displayed, but the <a href="#options-icons"><code>icons</code></a> option must be enabled, otherwise the <code>text</code> option will be ignored.</desc>
<type name="Boolean" />
</option>
Expand Down
Loading