Whether or not a close button should be displayed for this Calendar
Default Value: false
The value used to delimit individual dates in a date string passed to various Calendar functions.
Default Value: ","
The value used to delimit date fields in a date string passed to various Calendar functions.
Default Value: "/"
The value used to delimit date ranges in a date string passed to various Calendar functions.
Default Value: "-"
True if the Calendar should suppress weeks that are not a part of the current month. False by default.
Default Value: false
Whether or not an iframe shim should be placed under the Calendar to prevent select boxes from bleeding through in Internet Explorer 6 and below.
This property is enabled by default for IE6 and below. It is disabled by default for other browsers for performance reasons, but can be
enabled if required.
Default Value: true for IE6 and below, false for all other browsers
The setting that determines which length of month labels should be used. Possible values are "short" and "long".
Default Value: "long"
The setting that determines which length of weekday labels should be used. Possible values are "1char", "short", "medium", and "long".
Default Value: "short"
maxdate
- String | Date
The maximum selectable date in the current Calendar (mm/dd/yyyy)
Default Value: null
The position of the day in a month/year date string
Default Value: 2
The position of the month in a month/day date string
Default Value: 1
The position of the day in a month/day/year date string
Default Value: 2
The position of the month in a month/day/year date string
Default Value: 1
The position of the year in a month/day/year date string
Default Value: 3
mindate
- String | Date
The minimum selectable date in the current Calendar (mm/dd/yyyy)
Default Value: null
The long month labels for the current locale. The month labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"
The short month labels for the current locale. The month labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
True if the Calendar should allow multiple selections. False by default.
Default Value: false
The position of the month in the month year label string used as the Calendar header
Default Value: 1
The suffix used after the month when rendering the Calendar header. The suffix is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: " "
The position of the year in the month year label string used as the Calendar header
Default Value: 2
The suffix used after the year when rendering the Calendar header. The suffix is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ""
The position of the month in a month/year date string
Default Value: 1
The position of the year in a month/year date string
Default Value: 2
The image URL that should be used for the left navigation arrow. The image URL is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Deprecated You can customize the image by overriding the default CSS class for the left arrow - "calnavleft"
Default Value: null
The image URL that should be used for the right navigation arrow. The image URL is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Deprecated You can customize the image by overriding the default CSS class for the right arrow - "calnavright"
Default Value: null
navigator
- {Object|Boolean}
Configuration for the Month/Year CalendarNavigator UI which allows the user to jump directly to a
specific Month/Year without having to scroll sequentially through months.
Setting this property to null (default value) or false, will disable the CalendarNavigator UI.
Setting this property to true will enable the CalendarNavigatior UI with the default CalendarNavigator configuration values.
This property can also be set to an object literal containing configuration properties for the CalendarNavigator UI.
The configuration object expects the the following case-sensitive properties, with the "strings" property being a nested object.
Any properties which are not provided will use the default values (defined in the CalendarNavigator class).
- strings
- Object : An object with the properties shown below, defining the string labels to use in the Navigator's UI. The strings are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
- month
- HTML : The markup to use for the month label. Defaults to "Month".
- year
- HTML : The markup to use for the year label. Defaults to "Year".
- submit
- HTML : The markup to use for the submit button label. Defaults to "Okay".
- cancel
- HTML : The markup to use for the cancel button label. Defaults to "Cancel".
- invalidYear
- HTML : The markup to use for invalid year values. Defaults to "Year needs to be a number".
- monthFormat
- String : The month format to use. Either YAHOO.widget.Calendar.LONG, or YAHOO.widget.Calendar.SHORT. Defaults to YAHOO.widget.Calendar.LONG
- initialFocus
- String : Either "year" or "month" specifying which input control should get initial focus. Defaults to "year"
E.g.
var navConfig = {
strings: {
month:"Calendar Month",
year:"Calendar Year",
submit: "Submit",
cancel: "Cancel",
invalidYear: "Please enter a valid year"
},
monthFormat: YAHOO.widget.Calendar.SHORT,
initialFocus: "month"
}
Default Value: null
True if the Calendar should allow selection of out-of-month dates. False by default.
Default Value: false
The month/year representing the current visible Calendar date (mm/yyyy)
Default Value: Today's date
The date or range of dates representing the current Calendar selection
Default Value: []
True if the Calendar should show week row footers. False by default.
Default Value: false
True if the Calendar should show week row headers. False by default.
Default Value: false
True if the Calendar should show weekday labels. True by default.
Default Value: true
The weekday the week begins on. Default is 0 (Sunday = 0, Monday = 1 ... Saturday = 6).
Default Value: 0
The map of UI strings which the Calendar UI uses.
Default Value: An object with the properties shown below:
- previousMonth
- HTML : The markup to use for the "Previous Month" navigation label. Defaults to "Previous Month". The string is added to the DOM as HTML, and should be escaped by the implementor if coming from an external source.
- nextMonth
- HTML : The markup to use for the "Next Month" navigation UI. Defaults to "Next Month". The string is added to the DOM as HTML, and should be escaped by the implementor if coming from an external source.
- close
- HTML : The markup to use for the close button label. Defaults to "Close". The string is added to the DOM as HTML, and should be escaped by the implementor if coming from an external source.
The title to display above the Calendar's month header. The title is inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ""
The date to use to represent "Today".
Default Value: The client side date (new Date()) when the Calendar is instantiated.
The 1-character weekday labels for the current locale. The weekday labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["S", "M", "T", "W", "T", "F", "S"]
The long weekday labels for the current locale. The weekday labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
The medium weekday labels for the current locale. The weekday labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]
The short weekday labels for the current locale. The weekday labels are inserted into the DOM as HTML, and should be escaped by the implementor if coming from an external source.
Default Value: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"]
The positive or negative year offset from the Gregorian calendar year (assuming a January 1st rollover) to
be used when displaying and parsing dates. NOTE: All JS Date objects returned by methods, or expected as input by
methods will always represent the Gregorian year, in order to maintain date/month/week values.
Default Value: 0