Calendar
Display date.
Basic
Set value to specify the currently displayed month. If value is not specified, current month is displayed. value supports two-way binding.
Controller Type 2.13.1
You can set the type of the controller for Calendar header. When setting select, you can use formatter to customize label.
Custom Content
Customize what is displayed in the calendar cell by setting scoped-slot named date-cell. In scoped-slot you can get the date (the date of the current cell), data (including the type, isSelected, day attribute). For details, please refer to the API documentation below.
| Sun | Mon | Tue | Wed | Thu | Fri | Sat |
|---|---|---|---|---|---|---|
08-30 | 08-31 | 09-01 | 09-02 | 09-03 | 09-04 | 09-05 |
09-06 | 09-07 | 09-08 | 09-09 | 09-10 | 09-11 | 09-12 |
09-13 | 09-14 | 09-15 | 09-16 | 09-17 | 09-18 | 09-19 |
09-20 | 09-21 | 09-22 | 09-23 | 09-24 | 09-25 | 09-26 |
09-27 | 09-28 | 09-29 | 09-30 | 10-01 | 10-02 | 10-03 |
Range
Set the range attribute to specify the display range of the calendar. Start time must be Monday, end time must be Sunday, and the time span cannot exceed two months.
Customize header
| Sun | Mon | Tue | Wed | Thu | Fri | Sat |
|---|---|---|---|---|---|---|
30 | 31 | 1 | 2 | 3 | 4 | 5 |
6 | 7 | 8 | 9 | 10 | 11 | 12 |
13 | 14 | 15 | 16 | 17 | 18 | 19 |
20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 | 28 | 29 | 30 | 1 | 2 | 3 |
Localization
The default locale of is English, if you need to use other languages, please check Internationalization
Note, date time locale (month name, first day of the week ...) are also configured in localization.
API
Attributes
| Name | Description | Type | Default |
|---|---|---|---|
| model-value / v-model | binding value | Date | — |
| range | time range, including start time and end time. Start time must be start day of week, end time must be end day of week, the time span cannot exceed two months. | array | — |
| controller-type 2.13.1 | type of the controller for Calendar header | enum | button |
| formatter 2.13.1 | format label when controller-type is 'select' | Function | — |
Slots
| Name | Description | Type |
|---|---|---|
| date-cell | type indicates which month the date belongs, optional values are prev-month, current-month, next-month; isSelected indicates whether the date is selected; day is the formatted date in the format YYYY-MM-DD; date is date the cell represents | object |
| header | content of the Calendar header | object |
Exposes
| Name | Description | Type |
|---|---|---|
| selectedDay | currently selected date | object |
| pickDay | select a specific date | Function |
| selectDate | select date | Function |
| calculateValidatedDateRange | Calculate the validate date range according to the start and end dates | Function |
Type Declarations
Show declarations
type CalendarDateType =
'prev-month' | 'next-month' | 'prev-year' | 'next-year' | 'today'Source
Contributors
