Calendar
import {Calendar} from 'cx/widgets';Calendar is used for selecting dates.
<div class="widgets">
<Calendar
value-bind="$page.date" />
<Calendar
value-bind="$page.date"
minValue="2016-05-10"
maxValue="2016-05-20"
maxExclusive
refDate="2016-05-08"
dayData={{
[new Date("2016-05-11").toDateString()]: {
style: "color: red; font-weight: bold;",
className: 'test-class',
mod: 'holiday',
unselectable: false,
disabled: false
},
[new Date("2016-05-12").toDateString()]: {
disabled: true
},
[new Date("2016-05-13").toDateString()]: {
style: "outline: 1px solid red"
}
}}
/>
</div>Use
Enterkey to select a date. Use arrow keys,Home,End,Page UpandPage Downkeys to navigate the calendar.
Configuration
| Property | Description | Type |
|---|---|---|
refDate | View reference date. If no date is selected, this date is used to determine which month to show in the calendar. | string/Date |
value | Selected date. This should be a | string/Date |
autoFocus | Set to | boolean |
baseClass | Base CSS class to be applied to the calendar. Defaults to | string |
class | Additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list. | string/object |
dayData | Map of days to additional day information such as | object |
disabled | Defaults to | boolean |
disabledDaysOfWeek | Defines which days of week should be displayed as disabled, i.e. | array |
emptyText | Text to be rendered in view mode when the field is empty. | string |
enabled | The opposite of | boolean |
encoding | Sets the function that will be used to convert Date objects before writing data to the store.
Default implementation is | function |
error | Used for validation. If error evaluates to non-null, the field is marked in red. | string |
help | Additional content to be displayed next to the field. This is commonly used for presenting additional information or validation errors. | string/config |
helpPlacement | Set to | string |
helpSpacer | Indicates that | boolean |
highlightToday | Highlight today's date. Default is | boolean |
id | Id to be used on rendered input. | string |
inputAttrs | Additional attributes that should be rendered on the input element.
E.g. | object |
inputClass | Additional CSS class applied to the input element. Used for setting visual elements, such as borders and backgrounds. | string/object |
inputStyle | Style object applied to the input element. Used for setting visual elements, such as borders and backgrounds. | string/object |
label | Field label. For advanced use cases, see Labels. | string/config |
labelClass | Additional CSS class to be passed to the label object. | string |
labelPlacement | Set to | string |
labelStyle | Additional CSS styles to be passed to the label object. | string/object |
maxExclusive | Set to | boolean |
maxValue | Maximum date value. This should be a | string/Date |
minExclusive | Set to | boolean |
minValue | Minimum date value. This should be a | string/Date |
mod | Appearance modifier. For example, | string/array |
mode | Either | string |
outerLayout | Defines the outer layout which wraps the widget. | widget |
placeholder | Default text displayed when the field is empty. | string |
putInto | Used with outer layouts. Specifies the name of the content placeholder which should render the widget. | string |
readOnly | Defaults to | boolean |
required | Defaults to | boolean |
showTodayButton | Set to | boolean |
style | Style object applied to the wrapper div. Used for setting the dimensions of the element. | string/object |
tabIndex | Custom tab index to be set on the field. | string |
tabOnEnterKey | Set to | boolean |
todayButtonText | Localizable text for the todayButton. Defaults to | string |
tooltip | Tooltip configuration. For more info see Tooltips. | string/object |
trackFocus | If set to | boolean |
validationMode | Defines how to present validation errors. Default mode is | string |
validationParams | An structured binding for additional validation parameters. Useful if validation depends on values
from other fields, e.g. confirm password. Calculated value is passed as the third argument to | structure |
vdomKey | Key that will be used as the key when rendering the React component. | string |
viewMode | Set to | boolean |
visible | Visibility of the widget. Defaults to | boolean |
visited | Validation errors are not shown until the user visits the field. Setting this field to | boolean |