datepicker.xml

<?xml version="1.0"?>
<entry name="datepicker" type="widget" widget-element="datepicker">
	<title>Datepicker Widget</title>
	<desc>Select a date from a popup or inline calendar</desc>
	<longdesc>
		<p>The jQuery UI Datepicker is a highly configurable plugin that adds datepicker functionality to your pages. You can customize the date format and language, restrict the selectable date ranges and add in buttons and other navigation options easily.</p>

		<p>By default, the datepicker calendar opens in a small overlay when the associated text field gains focus. For an inline calendar, simply attach the datepicker to a div or span.</p>

		<h3>Keyboard interaction</h3>
		<p>While the datepicker is open, the following key commands are available:</p>
		<ul>
			<li>PAGE UP: Move to the previous month.</li>
			<li>PAGE DOWN: Move to the next month.</li>
			<li>CTRL+PAGE UP: Move to the previous year.</li>
			<li>CTRL+PAGE DOWN: Move to the next year.</li>
			<li>CTRL+HOME: Move to the current month. Open the datepicker if closed.</li>
			<li>CTRL+LEFT: Move to the previous day.</li>
			<li>CTRL+RIGHT: Move to the next day.</li>
			<li>CTRL+UP: Move to the previous week.</li>
			<li>CTRL+DOWN: Move the next week.</li>
			<li>ENTER: Select the focused date.</li>
			<li>CTRL+END: Close the datepicker and erase the date.</li>
			<li>ESCAPE: Close the datepicker without selection.</li>
		</ul>

		<h3 id="utility-functions">Utility functions</h3>
		<ul>
			<li>$.datepicker.setDefaults( settings ) - Set settings for all datepicker instances.</li>
			<li>$.datepicker.formatDate( format, date, settings ) - Format a date into a string value with a specified format.</li>
			<li>$.datepicker.parseDate( format, value, settings )  - Extract a date from a string value with a specified format.</li>
			<li>$.datepicker.iso8601Week( date ) - Determine the week of the year for a given date: 1 to 53.</li>
			<li>$.datepicker.noWeekends - Set as beforeShowDay function to prevent selection of weekends.</li>
		</ul>

		<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.</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>
		<p>And can then override an individual datepicker for a specific locale:</p>
		<code>$( selector ).datepicker( $.datepicker.regional[ "fr" ] );</code>
	</longdesc>
	<note id="functional-css"/>
	<added>1.0</added>
	<options>
		<option name="altField" default='""'>
			<desc>An input element that is to be updated with the selected date from the datepicker. Use the <a href="#option-altFormat"><code>altFormat</code></a> option to change the format of the date within this field. Leave as blank for no alternate field.</desc>
			<type name="Selector"/>
			<type name="jQuery"/>
			<type name="Element"/>
		</option>
		<option name="altFormat" type="String" default='""'>
			<desc>The <a href="#option-dateFormat"><code>dateFormat</code></a> to be used for the <a href="#option-altField"><code>altField</code></a> option. This allows one date format to be shown to the user for selection purposes, while a different format is actually sent behind the scenes. For a full list of the possible formats see the [[UI/Datepicker/formatDate|formatDate]] function</desc>
		</option>
		<option name="appendText" type="String" default='""'>
			<desc>The text to display after each date field, e.g., to show the required format.</desc>
		</option>
		<option name="autoSize" type="Boolean" default="false">
			<desc>Set to <code>true</code> to automatically resize the input field to accommodate dates in the current <a href="#option-dateFormat"><code>dateFormat</code></a>.</desc>
		</option>
		<option name="buttonImage" type="String" default='""'>
			<desc>The URL for the popup button image. If set, the <a href="#option-buttonText"><code>buttonText</code></a> option becomes the <code>alt</code> value and is not directly displayed.</desc>
		</option>
		<option name="buttonImageOnly" type="Boolean" default="false">
			<desc>Whether the button image should be rendered by itself instead of inside a button element.</desc>
		</option>
		<option name="buttonText" type="String" default='"..."'>
			<desc>The text to display on the trigger button. Use in conjunction with the <a href="#option-showOn"><code>showOn</code></a> option set to <code>"button"</code> or <code>"both"</code>.</desc>
		</option>
		<option name="calculateWeek" type="Function" default="jQuery.datepicker.iso8601Week">
			<desc>A function to calculate the week of the year for a given date. The default implementation uses the ISO 8601 definition: weeks start on a Monday; the first week of the year contains the first Thursday of the year.</desc>
		</option>
		<option name="changeMonth" type="Boolean" default="false">
			<desc>Whether the month should be rendered as a dropdown instead of text.</desc>
		</option>
		<option name="changeYear" type="Boolean" default="false">
			<desc>Whether the year should be rendered as a dropdown instead of text. Use the <a href="#option-yearRange"><code>yearRange</code></a> option to control which years are made available for selection.</desc>
		</option>
		<option name="closeText" type="String" default='"Done"'>
			<desc>The text to display for the close link. Use the <a href="#option-showButtonPanel"><code>showButtonPanel</code></a> option to display this button.</desc>
		</option>
		<option name="constrainInput" type="Boolean" default="true">
			<desc>When <code>true</code>, entry in the input field is constrained to those characters allowed by the current <a href="#option-dateFormat"><code>dateFormat</code></a> option.</desc>
		</option>
		<option name="currentText" type="String" default='"Today"'>
			<desc>The text to display for the current day link. Use the <a href="#option-showButtonPanel"><code>showButtonPanel</code></a> option to display this button.</desc>
		</option>
		<option name="dateFormat" type="String" default='"mm/dd/yy"'>
			<desc>The format for parsed and displayed dates. For a full list of the possible formats see the <code>[[UI/Datepicker/formatDate|formatDate]]</code> function.</desc>
		</option>
		<option name="dayNames" type="Array" default='[ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]'>
			<desc>The list of long day names, starting from Sunday, for use as requested via the <a href="#option-dateFormat"><code>dateFormat</code></a> option.</desc>
		</option>
		<option name="dayNamesMin" type="Array" default='[ "Su", "Mo", "Tu", "We", "Th", "Fr", "Sa" ]'>
			<desc>The list of minimised day names, starting from Sunday, for use as column headers within the datepicker.</desc>
		</option>
		<option name="dayNamesShort" type="Array" default='[ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" ]'>
			<desc>The list of abbreviated day names, starting from Sunday, for use as requested via the <a href="#option-dateFormat"><code>dateFormat</code></a> option.</desc>
		</option>
		<option name="defaultDate" default="null">
			<desc>Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object or as a string in the current <code>[[UI/Datepicker#option-dateFormat|dateFormat]]</code>, or a number of days from today (e.g. +7) or a string of values and periods ('y' for years, 'm' for months, 'w' for weeks, 'd' for days, e.g. '+1m +7d'), or null for today.</desc>
			<type name="Date">
				<desc>A date object containing the default date.</desc>
			</type>
			<type name="Number">
				<desc>A number of days from today. For example <code>2</code> represents two days from today and <code>-1</code> represents yesterday.</desc>
			</type>
			<type name="String">
				<desc>A string in the format defined by the <a href="#option-dateFormat"><code>dateFormat</code></a> option, or a relative date. Relative dates must contain value and period pairs; valid periods are <code>"y"</code> for years, <code>"m"</code> for months, <code>"w"</code> for weeks, and <code>"d"</code> for days. For example, <code>"+1m +7d"</code> represents one month and seven days from today.</desc>
			</type>
		</option>
		<option name="duration" default='"normal"'>
			<desc>Control the speed at which the datepicker appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast").</desc>
			<type nmae="Number"/>
			<type name="String"/>
		</option>
		<option name="firstDay" type="Integer" default="0">
			<desc>Set the first day of the week: Sunday is <code>0</code>, Monday is <code>1</code>, etc.</desc>
		</option>
		<option name="gotoCurrent" type="Boolean" default="false">
			<desc>When <code>true</code>, the current day link moves to the currently selected date instead of today.</desc>
		</option>
		<option name="hideIfNoPrevNext" type="Boolean" default="false">
			<desc>Normally the previous and next links are disabled when not applicable (see the <a href="#option-minDate"><code>minDate</code></a> and <a href="#option-maxDate"><code>maxDate</code></a> options). You can hide them altogether by setting this attribute to <code>true</code>.</desc>
		</option>
		<option name="isRTL" type="Boolean" default="false">
			<desc>Whether the current language is drawn from right to left.</desc>
		</option>
		<option name="maxDate" default="null">
			<desc>The maximum selectable date. When set to <code>null</code>, there is no maximum.</desc>
			<type name="Date">
				<desc>A date object containing the maximum date.</desc>
			</type>
			<type name="Number">
				<desc>A number of days from today. For example <code>2</code> represents two days from today and <code>-1</code> represents yesterday.</desc>
			</type>
			<type name="String">
				<desc>A string in the format defined by the <a href="#option-dateFormat"><code>dateFormat</code></a> option, or a relative date. Relative dates must contain value and period pairs; valid periods are <code>"y"</code> for years, <code>"m"</code> for months, <code>"w"</code> for weeks, and <code>"d"</code> for days. For example, <code>"+1m +7d"</code> represents one month and seven days from today.</desc>
			</type>
		</option>
		<option name="minDate" default="null">
			<desc>The minimum selectable date. When set to <code>null</code>, there is no minimum.</desc>
			<type name="Date">
				<desc>A date object containing the minimum date.</desc>
			</type>
			<type name="Number">
				<desc>A number of days from today. For example <code>2</code> represents two days from today and <code>-1</code> represents yesterday.</desc>
			</type>
			<type name="String">
				<desc>A string in the format defined by the <a href="#option-dateFormat"><code>dateFormat</code></a> option, or a relative date. Relative dates must contain value and period pairs; valid periods are <code>"y"</code> for years, <code>"m"</code> for months, <code>"w"</code> for weeks, and <code>"d"</code> for days. For example, <code>"+1m +7d"</code> represents one month and seven days from today.</desc>
			</type>
		</option>
		<option name="monthNames" type="Array" default='[ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ]'>
			<desc>The list of full month names, for use as requested via the <a href="#option-dateFormat"><code>dateFormat</code></a> option.</desc>
		</option>
		<option name="monthNamesShort" type="Array" default='[ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]'>
			<desc>The list of abbreviated month names, as used in the month header on each datepicker and as requested via the <a href="#option-dateFormat"><code>dateFormat</code></a> option.</desc>
		</option>
		<option name="navigationAsDateFormat" type="Boolean" default="false">
			<desc>Whether the <a href="#option-prevText"><code>prevText</code></a> and <a href="#option-nextText"><code>nextText</code></a> options should be parsed as dates by the <code>[[UI/Datepicker/formatDate|formatDate]]</code> function, allowing them to display the target month names for example.</desc>
		</option>
		<option name="nextText" type="String" default='"Next"'>
			<desc>The text to display for the next month link. With the standard ThemeRoller styling, this value is replaced by an icon.</desc>
		</option>
		<option name="numberOfMonths" default="1">
			<desc>The number of months to show at once.</desc>
			<type name="Number">
				<desc>The number of months to display in a single row.</desc>
			</type>
			<type name="Array">
				<desc>An array defining the number of rows and columns to display.</desc>
			</type>
		</option>
		<option name="prevText" type="String" default='"Prev"'>
			<desc>The text to display for the previous month link. With the standard ThemeRoller styling, this value is replaced by an icon.</desc>
		</option>
		<option name="selectOtherMonths" type="Boolean" default="false">
			<desc>Whether days in other months shown before or after the current month are selectable. This only applies if the <a href="#option-showOtherMonths"><code>showOtherMonths</code></a> option is set to <code>true</code>.</desc>
		</option>
		<option name="shortYearCutoff" default='"+10"'>
			<desc>The cutoff year for determining the century for a date (used in conjunction with <code>[[UI/Datepicker#option-dateFormat|dateFormat]]</code> 'y'). Any dates entered with a year value less than or equal to the cutoff year are considered to be in the current century, while those greater than it are deemed to be in the previous century.</desc>
			<type name="Number">
				<desc>A value between <code>0</code> and <code>99</code> indicating the cutoff year.</desc>
			</type>
			<type name="String">
				<desc>A relative number of years from the current year, e.g., <code>"+3"</code> or <code>"-5"</code>.</desc>
			</type>
		</option>
		<option name="showAnim" type="String" default='"show"'>
			<desc>The name of the animation used to show and hide the datepicker. Use <code>"show"</code> (the default), <code>"slideDown"</code>, <code>"fadeIn"</code>, any of the <a href="/category/effects/">jQuery UI effects</a>. Set to an empty string to disable animation.</desc>
		</option>
		<option name="showButtonPanel" type="Boolean" default="false">
			<desc>Whether to show the button panel.</desc>
		</option>
		<option name="showCurrentAtPos" type="Number" default="0">
			<desc>When displaying multiple months via the <a href="#option-numberOfMonths"><code>numberOfMonths</code></a> option, the <code>showCurrentAtPos</code> option defines which position to display the current month in.</desc>
		</option>
		<option name="showMonthAfterYear" type="Boolean" default="false">
			<desc>Whether to show the month after the year in the header.</desc>
		</option>
		<option name="showOn" type="String" default='"focus"'>
			<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="{}">
			<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>
		</option>
		<option name="showOtherMonths" type="Boolean" default="false">
			<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>
		</option>
		<option name="showWeek" type="Boolean" default="false">
			<desc>When <code>true</code>, a column is added to show the week of the year. The <a href="#option-calculateWeek"><code>calculateWeek</code></a> option determines how the week of the year is calculated. You may also want to change the <a href="#option-firstDay"><code>firstDay</code></a> option.</desc>
		</option>
		<option name="stepMonths" type="Number" default="1">
			<desc>Set how many months to move when clicking the previous/next links.</desc>
		</option>
		<option name="weekHeader" type="String" default='"Wk"'>
			<desc>The text to display for the week of the year column heading. Use the <a href="#option-showWeek"><code>showWeek</code></a> option to display this column.</desc>
		</option>
		<option name="yearRange" type="String" default='"c-10:c+10"'>
			<desc>The range of years displayed in the year drop-down: either relative to today's year (<code>"-nn:+nn"</code>), relative to the currently selected year (<code>"c-nn:c+nn"</code>), absolute (<code>"nnnn:nnnn"</code>), or combinations of these formats (<code>"nnnn:-nn"</code>). Note that this option only affects what appears in the drop-down, to restrict which dates may be selected use the <a href="#option-minDate"><code>minDate</code></a> and/or <a href="#option-maxDate"><code>maxDate</code></a> options.</desc>
		</option>
		<option name="yearSuffix" type="String" default='""'>
			<desc>Additional text to display after the year in the month headers.</desc>
		</option>

		<!-- events -->
		<option name="beforeShow" type="Function" default="null">
			<argument name="input" type="Element"/>
			<argument name="inst" type="Object"/>
			<desc>A function that takes an input field and current datepicker instance and returns an options object to update the datepicker with. It is called just before the datepicker is displayed.</desc>
		</option>
		<option name="beforeShowDay" type="Function" default="null">
			<argument name="date" type="Date"/>
			<desc>A function takes a date as a parameter and must return an array with <code>[0]</code> equal to <code>true</code>/<code>false</code> indicating whether or not this date is selectable, <code>[1]</code> equal to a CSS class name or <code>""</code> for the default presentation, and <code>[2]</code> an optional popup tooltip for this date. It is called for each day in the datepicker before it is displayed.</desc>
		</option>
		<option name="onChangeMonthYear" type="Function" default="null">
			<argument name="year" type="Integer"/>
			<argument name="month" type="Integer"/>
			<argument name="inst" type="Object"/>
			<desc>Called when the datepicker moves to a new month and/or year. The function receives the selected year, month (1-12), and the datepicker instance as parameters. <code>this</code> refers to the associated input field.</desc>
		</option>
		<option name="onClose" type="Function" default="null">
			<argument name="dateText" type="String"/>
			<argument name="inst" type="Object"/>
			<desc>Called when the datepicker is closed, whether or not a date is selected. The function receives the selected date as text (<code>""</code> if none) and the datepicker instance as parameters. <code>this</code> refers to the associated input field.</desc>
		</option>
		<option name="onSelect" type="Function" default="null">
			<argument name="dateText" type="String"/>
			<argument name="inst" type="Object"/>
			<desc>Called when the datepicker is selected. The function receives the selected date as text and the datepicker instance as parameters. <code>this</code> refers to the associated input field.</desc>
		</option>
		<option name="beforeShow" type="Function">
			<desc>Can be a function that takes an input field and current datepicker instance and returns an options object to update the datepicker with. It is called just before the datepicker is displayed.</desc>
			<argument name="input" type="jQuery"/>
			<argument name="inst" type="jQuery"/>
		</option>
		<option name="beforeShowDay" type="Function">
			<desc>The function takes a date as a parameter and must return an array with [0] equal to true/false indicating whether or not this date is selectable, [1] equal to a CSS class name(s) or "" for the default presentation, and [2] an optional popup tooltip for this date. It is called for each day in the datepicker before it is displayed.</desc>
			<argument name="date" type="Date"/>
		</option>
		<option name="onChangeMonthYear" type="Function">
			<desc>Allows you to define your own event when the datepicker moves to a new month and/or year. The function receives the selected year, month (1-12), and the datepicker instance as parameters. this refers to the associated input field.</desc>
			<argument name="year" type="Integer"/>
			<argument name="month" type="Integer"/>
			<argument name="inst" type="jQuery"/>
		</option>
		<option name="onClose" type="Function">
			<desc>Allows you to define your own event when the datepicker is closed, whether or not a date is selected. The function receives the selected date as text ("" if none) and the datepicker instance as parameters. this refers to the associated input field.</desc>
			<argument name="dateTxt" type="String"/>
			<argument name="inst" type="jQuery"/>
		</option>
		<option name="onSelect" type="Function">
			<desc>Allows you to define your own event when the datepicker is selected. The function receives the selected date as text and the datepicker instance as parameters. this refers to the associated input field.</desc>
			<argument name="dateTxt" type="String"/>
			<argument name="inst" type="jQuery"/>
		</option>
	</options>
	<methods>
		<xi:include href="../includes/widget-method-destroy.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
		<method name="dialog">
			<desc>Opens the datepicker in a dialog box.</desc>
			<argument name="date">
				<desc>The initial date.</desc>
				<type name="String"/>
				<type name="Date"/>
			</argument>
			<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>
			<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>
			</argument>
		</method>
		<method name="isDisabled" return="Boolean">
			<desc>Determine whether a date picker has been disabled.</desc>
		</method>
		<method name="hide">
			<desc>Close a previously opened date picker.</desc>
		</method>
		<method name="show">
			<desc>Open the date picker. If the datepicker is attached to an input, the input must be visible for the datepicker to be shown.</desc>
		</method>
		<method name="refresh">
			<desc>Redraw the date picker, after having made some external modifications.</desc>
		</method>
		<method name="getDate" return="Date">
			<desc>Returns the current date for the datepicker or <code>null</code> if no date has been selected.</desc>
		</method>
		<method name="setDate">
			<desc>Sets the date for the datepicker. The new date may be a <code>Date</code> object or a string in the current <a href="#option-dateFormat">date format</a> (e.g., <code>"01/26/2009"</code>), a number of days from today (e.g., <code>+7</code>) or a string of values and periods (<code>"y"</code> for years, <code>"m"</code> for months, <code>"w"</code> for weeks, <code>"d"</code> for days, e.g., <code>"+1m +7d"</code>), or <code>null</code> to clear the selected date.</desc>
			<argument name="date" type="Date">
				<desc>The new date.</desc>
			</argument>
		</method>
		<xi:include href="../includes/widget-method-option.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
		<xi:include href="../includes/widget-method-widget.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
	</methods>
	<example>
		<height>300</height>
		<desc>A simple jQuery UI Datepicker.</desc>
		<code><![CDATA[
$( "#datepicker" ).datepicker();
]]></code>
		<html><![CDATA[
<div id="datepicker"></div>
]]></html>
	</example>
	<category slug="widgets"/>
</entry>