Skip to content

Entries: Use "properties" when referring to individual options #251

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 2 commits into from
Closed

Entries: Use "properties" when referring to individual options #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0369086
Entries: Use "properties" when referring to individual options
jzaefferer Feb 24, 2015
a05f312
[tmp]: fix wording for accordion
jzaefferer Feb 24, 2015
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
2 changes: 1 addition & 1 deletion entries/accordion.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<desc>Name of <a href="/easings/">easing</a> to use with default duration.</desc>
</type>
<type name="Object">
<desc>Animation settings with <code>easing</code> and <code>duration</code> properties.
<desc>An object containing <code>easing</code> and <code>duration</code> properties to configure animations.
<ul>
<li>Can also contain a <code>down</code> property with any of the above options.</li>
<li>"Down" animations occur when the panel being activated has a lower index than the currently active panel.</li>
Expand Down
18 changes: 9 additions & 9 deletions entries/datepicker.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@

<h3 id="utility-functions">Utility functions</h3>

<h4 id="utility-setDefaults">$.datepicker.setDefaults( settings )</h4>
<p>Change the default settings for all date pickers.</p>
<p>Use the <a href="#method-option"><code>option()</code></a> method to change settings for individual instances.</p>
<h4 id="utility-setDefaults">$.datepicker.setDefaults( options )</h4>
<p>Change the default options for all date pickers.</p>
<p>Use the <a href="#method-option"><code>option()</code></a> method to change options for individual instances.</p>
<div>
<strong>Code examples:</strong>
<p>Set all date pickers to open on focus or a click on an icon.</p>
Expand All @@ -47,7 +47,7 @@
</code></pre>
</div>

<h4 id="utility-formatDate">$.datepicker.formatDate( format, date, settings )</h4>
<h4 id="utility-formatDate">$.datepicker.formatDate( format, date, options )</h4>
<p>Format a date into a string value with a specified format.</p>
<p>The format can be combinations of the following:</p>
<ul>
Expand Down Expand Up @@ -101,7 +101,7 @@
</code></pre>
</div>

<h4 id="utility-parseDate">$.datepicker.parseDate( format, value, settings )</h4>
<h4 id="utility-parseDate">$.datepicker.parseDate( format, value, options )</h4>
<p>Extract a date from a string value with a specified format.</p>
<p>The format can be combinations of the following:</p>
<ul>
Expand Down Expand Up @@ -175,7 +175,7 @@
</div>

<h3>Localization</h3>
<p>Datepicker provides support for localizing its content to cater for different languages and date formats. Each localization is contained within its own file with the language code appended to the name, e.g., <code>jquery.ui.datepicker-fr.js</code> for French. The desired localization file should be included after the main datepicker code. Each localization file adds its settings to the set of available localizations and automatically applies them as defaults for all instances. Localization files can be found at <a href="https://github.com/jquery/jquery-ui/tree/master/ui/i18n">https://github.com/jquery/jquery-ui/tree/master/ui/i18n</a>.</p>
<p>Datepicker provides support for localizing its content to cater for different languages and date formats. Each localization is contained within its own file with the language code appended to the name, e.g., <code>jquery.ui.datepicker-fr.js</code> for French. The desired localization file should be included after the main datepicker code. Each localization file adds its options to the set of available localizations and automatically applies them as defaults for all instances. Localization files can be found at <a href="https://github.com/jquery/jquery-ui/tree/master/ui/i18n">https://github.com/jquery/jquery-ui/tree/master/ui/i18n</a>.</p>
<p>The <code>$.datepicker.regional</code> attribute holds an array of localizations, indexed by language code, with <code>""</code> referring to the default (English). Each entry is an object with the following attributes: <code>closeText</code>, <code>prevText</code>, <code>nextText</code>, <code>currentText</code>, <code>monthNames</code>, <code>monthNamesShort</code>, <code>dayNames</code>, <code>dayNamesShort</code>, <code>dayNamesMin</code>, <code>weekHeader</code>, <code>dateFormat</code>, <code>firstDay</code>, <code>isRTL</code>, <code>showMonthAfterYear</code>, and <code>yearSuffix</code>.</p>
<p>You can restore the default localizations with:</p>
<code>$.datepicker.setDefaults( $.datepicker.regional[ "" ] );</code>
Expand Down Expand Up @@ -405,7 +405,7 @@
<desc>When the datepicker should appear. The datepicker can appear when the field receives focus (<code>"focus"</code>), when a button is clicked (<code>"button"</code>), or when either event occurs (<code>"both"</code>).</desc>
</option>
<option name="showOptions" type="Object" default="{}" example-value='{ direction: "up" }'>
<desc>If using one of the jQuery UI effects for the <a href="#option-showAnim"><code>showAnim</code></a> option, you can provide additional settings for that animation via this option.</desc>
<desc>If using one of the jQuery UI effects for the <a href="#option-showAnim"><code>showAnim</code></a> option, you can provide additional properties for that animation using this option.</desc>
</option>
<option name="showOtherMonths" type="Boolean" default="false" example-value="true">
<desc>Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the <a href="#option-selectOtherMonths"><code>selectOtherMonths</code></a> option.</desc>
Expand Down Expand Up @@ -471,8 +471,8 @@
<argument name="onSelect" type="Function" optional="true">
<desc>A callback function when a date is selected. The function receives the date text and date picker instance as parameters.</desc>
</argument>
<argument name="settings" type="Options" optional="true">
<desc>The new settings for the date picker.</desc>
<argument name="options" type="Options" optional="true">
<desc>The new options for the date picker.</desc>
</argument>
<argument name="pos" type="Number[2] or MouseEvent" optional="true">
<desc>The position of the top/left of the dialog as <code>[x, y]</code> or a <code>MouseEvent</code> that contains the coordinates. If not specified the dialog is centered on the screen.</desc>
Expand Down
2 changes: 1 addition & 1 deletion entries/effect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<desc>A string indicating which <a href="/category/effects/">effect</a> to use for the transition.</desc>
</argument>
<argument name="options" type="Object" optional="true">
<desc>Effect-specific settings and <a href="/easings/">easing</a>.</desc>
<desc>Effect-specific properties and <a href="/easings/">easing</a>.</desc>
</argument>
<xi:include href="../includes/animation-argument-duration.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
Expand Down
2 changes: 1 addition & 1 deletion entries/hide.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<desc>A string indicating which <a href="/category/effects/">effect</a> to use for the transition.</desc>
</argument>
<argument name="options" type="Object" optional="true">
<desc>Effect-specific settings and <a href="/easings/">easing</a>.</desc>
<desc>Effect-specific properties and <a href="/easings/">easing</a>.</desc>
</argument>
<xi:include href="../includes/animation-argument-duration.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
Expand Down
6 changes: 3 additions & 3 deletions entries/jQuery.widget.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

<p>We can pass as many or as few options as we want during initialization. Any options that we don't pass will just use their default values.</p>

<p>You can pass multiple options arguments. Those arguments will be merged into one object (similar to <a href="//api.jquery.com/jQuery.extend/"><code>$.extend( true, target, object1, objectN )</code></a>). This is useful for sharing options between instances, while overriding some settings for each one:</p>
<p>You can pass multiple options arguments. Those arguments will be merged into one object (similar to <a href="//api.jquery.com/jQuery.extend/"><code>$.extend( true, target, object1, objectN )</code></a>). This is useful for sharing options between instances, while overriding some properties for each one:</p>

<pre><code>
var options = { modal: true, show: "slow" };
Expand Down Expand Up @@ -508,7 +508,7 @@ this._on( this.element, {
<desc>The element(s) to show.</desc>
</argument>
<argument name="option" type="Object">
<desc>The settings defining how to show the element.</desc>
<desc>The properties defining how to show the element.</desc>
</argument>
<argument name="callback" type="Function" optional="true">
<desc>Callback to invoke after the element has been fully shown.</desc>
Expand All @@ -532,7 +532,7 @@ this._show( this.element, this.options.show, function() {
<desc>The element(s) to hide.</desc>
</argument>
<argument name="option" type="Object">
<desc>The settings defining how to hide the element.</desc>
<desc>The properties defining how to hide the element.</desc>
</argument>
<argument name="callback" type="Function" optional="true">
<desc>Callback to invoke after the element has been fully hidden.</desc>
Expand Down
2 changes: 1 addition & 1 deletion entries/show.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<desc>A string indicating which <a href="/category/effects/">effect</a> to use for the transition.</desc>
</argument>
<argument name="options" type="Object" optional="true">
<desc>Effect-specific settings and <a href="/easings/">easing</a>.</desc>
<desc>Effect-specific properties and <a href="/easings/">easing</a>.</desc>
</argument>
<xi:include href="../includes/animation-argument-duration.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
Expand Down
4 changes: 2 additions & 2 deletions entries/tabs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
<event name="beforeLoad">
<desc>
<p>Triggered when a remote tab is about to be loaded, after the <a href="#event-beforeActivate"><code>beforeActivate</code></a> event. Can be canceled to prevent the tab panel from loading content; though the panel will still be activated. This event is triggered just before the Ajax request is made, so modifications can be made to <code>ui.jqXHR</code> and <code>ui.ajaxSettings</code>.</p>
<p><em>Note: Although <code>ui.ajaxSettings</code> is provided and can be modified, some of these settings have already been processed by jQuery. For example, <a href="//api.jquery.com/jQuery.ajaxPrefilter/">prefilters</a> have been applied, <code>data</code> has been processed, and <code>type</code> has been determined. The <code>beforeLoad</code> event occurs at the same time, and therefore has the same restrictions, as the <code>beforeSend</code> callback from <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax()</code></a>.</em></p>
<p><em>Note: Although <code>ui.ajaxSettings</code> is provided and can be modified, some of these properties have already been processed by jQuery. For example, <a href="//api.jquery.com/jQuery.ajaxPrefilter/">prefilters</a> have been applied, <code>data</code> has been processed, and <code>type</code> has been determined. The <code>beforeLoad</code> event occurs at the same time, and therefore has the same restrictions, as the <code>beforeSend</code> callback from <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax()</code></a>.</em></p>
</desc>
<argument name="event" type="Event"/>
<argument name="ui" type="Object">
Expand All @@ -186,7 +186,7 @@
<desc>The <code>jqXHR</code> object that is requesting the content.</desc>
</property>
<property name="ajaxSettings" type="Object">
<desc>The settings that will be used by <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax</code></a> to request the content.</desc>
<desc>The properties that will be used by <a href="//api.jquery.com/jQuery.ajax/"><code>jQuery.ajax</code></a> to request the content.</desc>
</property>
</argument>
</event>
Expand Down
2 changes: 1 addition & 1 deletion entries/toggle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<desc>A string indicating which <a href="/category/effects/">effect</a> to use for the transition.</desc>
</argument>
<argument name="options" type="Object" optional="true">
<desc>Effect-specific settings and <a href="/easings/">easing</a>.</desc>
<desc>Effect-specific properties and <a href="/easings/">easing</a>.</desc>
</argument>
<xi:include href="../includes/animation-argument-duration.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
Expand Down