|
altField
|
The jQuery selector for another field that is to be updated with the selected date from the datepicker. Use the altFormat setting below to change the format of the date within this field. Leave as blank for no alternate field.
Default: ''
|
|
altFormat
|
The dateFormat to be used for the altField 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 formatDate function
Default: ''
|
|
appendText
|
The text to display after each date field, e.g. to show the required format.
Default: ''
|
|
beforeShow
|
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.
Default: null
|
|
beforeShowDay
|
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 is it displayed.
Default: null
|
|
buttonImage
|
The URL for the popup button image. If set, button text becomes the alt value and is not directly displayed.
Default: ''
|
|
buttonImageOnly
|
Set to true to place an image after the field to use as the trigger without it appearing on a button.
Default: false
|
|
buttonText
|
The text to display on the trigger button. Use in conjunction with showOn equal to 'button' or 'both'.
Default: '...'
|
|
changeMonth
|
Allows you to change the month by selecting from a drop-down list. You can enable this feature by setting the attribute to true.
Default: false
|
|
changeYear
|
Allows you to change the year by selecting from a drop-down list. You can enable this feature by setting the attribute to true.
Default: false
|
|
closeText
|
The text to display for the close link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
Default: 'Done'
|
|
constrainInput
|
True if the input field is constrained to the current date format.
Default: true
|
|
currentText
|
The text to display for the current day link. This attribute is one of the regionalisation attributes. Use the showButtonPanel to display this button.
Default: 'Today'
|
|
dateFormat
|
The format for parsed and displayed dates. This attribute is one of the regionalisation attributes. For a full list of the possible formats see the formatDate function.
Default: 'mm/dd/yy'
|
|
dayNames
|
The list of long day names, starting from Sunday, for use as requested via the dateFormat setting. They also appear as popup hints when hovering over the corresponding column headings. This attribute is one of the regionalisation attributes.
Default: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
|
|
dayNamesMin
|
The list of minimised day names, starting from Sunday, for use as column headers within the datepicker. This attribute is one of the regionalisation attributes.
Default: ['Su', 'Mo', 'Tu', 'We', 'Th', 'Fr', 'Sa']
|
|
dayNamesShort
|
The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Default: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
|
|
defaultDate
|
Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object, 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.
Default: null
Types: Date, Number, String
|
|
duration
|
Control the speed at which the datepicker appears, it may be a time in milliseconds, a string representing one of the three predefined speeds ("slow", "normal", "fast"), or '' for immediately.
Default: 'normal'
Types: String, Number
|
|
firstDay
|
Set the first day of the week: Sunday is 0, Monday is 1, ... This attribute is one of the regionalisation attributes.
Default: 0
|
|
gotoCurrent
|
If true, the current day link moves to the currently selected date instead of today.
Default: false
|
|
hideIfNoPrevNext
|
Normally the previous and next links are disabled when not applicable (see minDate/maxDate). You can hide them altogether by setting this attribute to true.
Default: false
|
|
isRTL
|
True if the current language is drawn from right to left. This attribute is one of the regionalisation attributes.
Default: false
|
|
maxDate
|
Set a maximum selectable date via a Date object, 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 +1w'), or null for no limit.
Default: null
Types: Date, Number, String
|
|
minDate
|
Set a minimum selectable date via a Date object, 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. '-1y -1m'), or null for no limit.
Default: null
Types: Date, Number, String
|
|
monthNames
|
The list of full month names, as used in the month header on each datepicker and as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Default: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
|
|
monthNamesShort
|
The list of abbreviated month names, for use as requested via the dateFormat setting. This attribute is one of the regionalisation attributes.
Default: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
|
|
navigationAsDateFormat
|
When true the formatDate function is applied to the prevText, nextText, and currentText values before display, allowing them to display the target month names for example.
Default: false
|
|
nextText
|
The text to display for the next month link. This attribute is one of the regionalisation attributes. With the standard ThemeRoller styling, this value is replaced by an icon.
Default: 'Next'
|
|
numberOfMonths
|
Set how many months to show at once. The value can be a straight integer, or can be a two-element array to define the number of rows and columns to display.
Default: 1
Types: Number, Array
|
|
onChangeMonthYear
|
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.
Default: null
Types: function(year, month, inst)
|
|
onClose
|
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 and the datepicker instance as parameters. this refers to the associated input field.
Default: null
Types: function(dateText, inst)
|
|
onSelect
|
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.
Default: null
Types: function(dateText, inst)
|
|
prevText
|
The text to display for the previous month link. This attribute is one of the regionalisation attributes. With the standard ThemeRoller styling, this value is replaced by an icon.
Default: 'Prev'
|
|
shortYearCutoff
|
Set the cutoff year for determining the century for a date (used in conjunction with dateFormat 'y'). If a numeric value (0-99) is provided then this value is used directly. If a string value is provided then it is converted to a number and added to the current year. Once the cutoff year is calculated, any dates entered with a year value less than or equal to it are considered to be in the current century, while those greater than it are deemed to be in the previous century.
Default: '+10'
Types: String, Number
|
|
showAnim
|
Set the name of the animation used to show/hide the datepicker. Use 'show' (the default), 'slideDown', 'fadeIn', or any of the show/hide jQuery UI effects.
Default: 'show'
|
|
showButtonPanel
|
Whether to show the button panel.
Default: false
|
|
showCurrentAtPos
|
Specify where in a multi-month display the current month shows, starting from 0 at the top/left.
Default: 0
|
|
showMonthAfterYear
|
Whether to show the month after the year in the header.
Default: false
|
|
showOn
|
Have the datepicker appear automatically when the field receives focus ('focus'), appear only when a button is clicked ('button'), or appear when either event takes place ('both').
Default: 'focus'
|
|
showOptions
|
If using one of the jQuery UI effects for showAnim, you can provide additional settings for that animation via this option.
Default: {}
|
|
showOtherMonths
|
Display dates in other months (non-selectable) at the start or end of the current month.
Default: false
|
|
stepMonths
|
Set how many months to move when clicking the Previous/Next links.
Default: 1
|
|
yearRange
|
Control the range of years displayed in the year drop-down: either relative to current year (-nn:+nn) or absolute (nnnn:nnnn).
Default: '-10:+10'
|