element-plus/docs/en-US/component/calendar.md
Jeremy 8c2a2a69dd
docs(components): [calendar] (#10977)
* docs(components): [calendar]

* Update calendar docs with new syntax.
* Update description for calendar APIs.

* chore: remove backquote for API names

* chore: update scoped slots

* chore: apply suggestion

---------

Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com>
2023-02-14 22:29:36 +08:00

3.5 KiB

title lang
Calendar en-US

Calendar

Display date.

Basic

:::demo Set value to specify the currently displayed month. If value is not specified, current month is displayed. value supports two-way binding.

calendar/basic

:::

Custom Content

:::demo 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.

calendar/customize

:::

Range

:::demo 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.

calendar/range

:::

Customize header

:::demo

calendar/header

:::

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][Date, Date]

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]{ data: { type: 'prev-month' | 'current-month' | 'next-month', isSelected: boolean, day: string, date: Date } }
header content of the Calendar header ^[object]{ date: string }