Provides a form Date field component for selecting dates. DatePicker presents a drop down monthly calendar for users to select dates from.
JavaScript must be enabled in the client browser to use the drop down calendar. If JavaScript is not enabled users can still enter a date value in the HTML text field.
This component needs a Body component and a Shell or ScriptIncludes component to work.
See also: DropdownTimePicker , DatePicker
Name | Type | Required | Default | Description |
---|---|---|---|---|
value | Object | yes | The date value. Take care to ensure date time values are 'normalized' before performing any millisec based comparison or equality operations. | |
disabled | boolean | no | false | Controls whether the date field and calendar button is active or not. |
displayName | String | no | The user-presentable name for the component, which will be used by a FieldLabel connected to the component. | |
validators | Array or collection of Validator | no |
The validators to apply to the component. Something along the lines of:
validators:required .See also:Validation |
|
translator | Translator | no | translator:date,pattern=dd MMM yyyy |
The translator to use when displaying and parsing the date.
See also:Validation |
iconAlt | String | no | literal:Select a Date | The textual name given to the date picking icon before the image is loaded. |
displayWeeks | int | no | 6 | Number of weeks to display, default is 6. |
adjustWeeks | boolean | no | false | If true, weekly size of calendar changes to accomodate the month. If false (the default), 42 day format is used. |
startDate | Object | no | First available date in the calendar set. If specified then no date earlier than startDate will be selectable. | |
endDate | Object | no | Last available date in the calendar set. If specified then no date later than endDate will be selectable. | |
weekStartsOn | int | no | 0 | Adjusts the first day of the week 0==Sunday..6==Saturday. |
staticDisplay | boolean | no | false | Disables all incremental controls, must pick a date in the current display. Default is false. |
Body: removed
Informal parameters: allowed
Reserved parameters: name, autocomplete