|
27 | 27 |
|
28 | 28 | <h3 id="utility-functions">Utility functions</h3> |
29 | 29 |
|
30 | | - <h4 id="utility-setDefaults">$.datepicker.setDefaults( settings )</h4> |
31 | | - <p>Change the default settings for all date pickers.</p> |
32 | | - <p>Use the <a href="#method-option"><code>option()</code></a> method to change settings for individual instances.</p> |
| 30 | + <h4 id="utility-setDefaults">$.datepicker.setDefaults( options )</h4> |
| 31 | + <p>Change the default options for all date pickers.</p> |
| 32 | + <p>Use the <a href="#method-option"><code>option()</code></a> method to change options for individual instances.</p> |
33 | 33 | <div> |
34 | 34 | <strong>Code examples:</strong> |
35 | 35 | <p>Set all date pickers to open on focus or a click on an icon.</p> |
|
47 | 47 | </code></pre> |
48 | 48 | </div> |
49 | 49 |
|
50 | | - <h4 id="utility-formatDate">$.datepicker.formatDate( format, date, settings )</h4> |
| 50 | + <h4 id="utility-formatDate">$.datepicker.formatDate( format, date, options )</h4> |
51 | 51 | <p>Format a date into a string value with a specified format.</p> |
52 | 52 | <p>The format can be combinations of the following:</p> |
53 | 53 | <ul> |
|
101 | 101 | </code></pre> |
102 | 102 | </div> |
103 | 103 |
|
104 | | - <h4 id="utility-parseDate">$.datepicker.parseDate( format, value, settings )</h4> |
| 104 | + <h4 id="utility-parseDate">$.datepicker.parseDate( format, value, options )</h4> |
105 | 105 | <p>Extract a date from a string value with a specified format.</p> |
106 | 106 | <p>The format can be combinations of the following:</p> |
107 | 107 | <ul> |
|
175 | 175 | </div> |
176 | 176 |
|
177 | 177 | <h3>Localization</h3> |
178 | | - <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> |
| 178 | + <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> |
179 | 179 | <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> |
180 | 180 | <p>You can restore the default localizations with:</p> |
181 | 181 | <code>$.datepicker.setDefaults( $.datepicker.regional[ "" ] );</code> |
|
405 | 405 | <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> |
406 | 406 | </option> |
407 | 407 | <option name="showOptions" type="Object" default="{}" example-value='{ direction: "up" }'> |
408 | | - <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> |
| 408 | + <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> |
409 | 409 | </option> |
410 | 410 | <option name="showOtherMonths" type="Boolean" default="false" example-value="true"> |
411 | 411 | <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> |
|
471 | 471 | <argument name="onSelect" type="Function" optional="true"> |
472 | 472 | <desc>A callback function when a date is selected. The function receives the date text and date picker instance as parameters.</desc> |
473 | 473 | </argument> |
474 | | - <argument name="settings" type="Options" optional="true"> |
475 | | - <desc>The new settings for the date picker.</desc> |
| 474 | + <argument name="options" type="Options" optional="true"> |
| 475 | + <desc>The new options for the date picker.</desc> |
476 | 476 | </argument> |
477 | 477 | <argument name="pos" type="Number[2] or MouseEvent" optional="true"> |
478 | 478 | <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> |
|
0 commit comments