|
1 | 1 | # Available props |
2 | 2 |
|
3 | 3 | | Prop | Type | Default | Description | |
4 | | -| ----------------------------- | ----------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------- | |
| 4 | +|-------------------------------| ----------------------------- | ----------- |----------------------------------------------------------------------------------------------------------------------------------| |
5 | 5 | | append-to-body | Boolean | false | Append datepicker calendar to body | |
6 | 6 | | autofocus | Boolean | false | Sets html `autofocus` attribute on input | |
7 | 7 | | bootstrap-styling | Boolean | false | Use bootstrap v4 styling classes. | |
8 | | -| calendar-button | Boolean | false | Show an icon that that can be clicked | |
9 | | -| calendar-button-icon | String | | (Deprecated for slot) Use icon for button (ex: fa fa-calendar) | |
10 | | -| calendar-button-icon-content | String | | (Deprecated for slot) Use for material-icons (ex: event) | |
| 8 | +| calendar-button | Boolean | false | Show an button that opens/closes the datepicker. Customisable via [slots](../Slots/README.md) | |
| 9 | +| calendar-button-icon | String | | (Deprecated for slot) Use icon for button (ex: fa fa-calendar) | |
| 10 | +| calendar-button-icon-content | String | | (Deprecated for slot) Use for material-icons (ex: event) | |
11 | 11 | | calendar-class | String|Object | | CSS class applied to the calendar el | |
12 | | -| clear-button | Boolean | false | Show an icon for clearing the date | |
13 | | -| clear-button-icon | String | | (Deprecated for slot) Use icon for button (ex: fa fa-times) | |
| 12 | +| clear-button | Boolean | false | Show a button for clearing the date. Customisable via [slots](../Slots/README.md) | |
| 13 | +| clear-button-icon | String | | (Deprecated for slot) Use icon for button (ex: fa fa-times) | |
14 | 14 | | day-cell-content | Function | | Use to render custom content in day cell | |
15 | | -| disabled | Boolean | false | If `true`, disable Datepicker on screen | |
16 | | -| disabled-dates | Object | | See below for configuration | |
| 15 | +| disabled | Boolean | false | If `true`, disable datepicker on screen | |
| 16 | +| disabled-dates | Object | | See [Disabled Dates](../DisabledDates/README.md) for configuration | |
17 | 17 | | first-day-of-week | String | sun | Sets the first day of the week. Possible values: _sun_, _mon_, _tue_, _wed_, _thu_, _fri_, _sat_ | |
18 | 18 | | fixed-position | String | | Set a fixed position for the picker. Possible values: _bottom_, _bottom-left_, _bottom-right_, _top_, _top-left_ and _top-right_ | |
19 | 19 | | format | String|Function | dd MMM yyyy | Date formatting string or function | |
20 | 20 | | full-month-name | Boolean | false | To show the full month name | |
| 21 | +| highlighted | Object | | See [Highlighted Dates](../HighlightedDates/README.md) for configuration | |
21 | 22 | | id | String | | Input id | |
22 | 23 | | initial-view | String | minimumView | If set, open on that view | |
23 | 24 | | inline | Boolean | | To show the datepicker always open | |
|
37 | 38 | | show-calendar-on-focus | Boolean | false | Opens the calendar on input focus | |
38 | 39 | | show-calendar-on-button-click | Boolean | false | Only open the calendar on calendar-button click | |
39 | 40 | | tabindex | String|Number | | Tabindex for the input field | |
40 | | -| typeable | Boolean | false | If `true`, allow the user to type the date | |
| 41 | +| typeable | Boolean | false | If `true`, allow the user to type the date. See [Parsing typed input](../ParsingDates/README.md) | |
41 | 42 | | use-utc | Boolean | false | Use UTC for time calculations. See [Local Dates vs UTC Dates](../UtcDates/README.md) | |
42 | 43 | | value | Date|String | | Date value of the datepicker | |
43 | 44 | | wrapper-class | String|Object | | CSS class applied to the outer div | |
|
0 commit comments