mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-26 20:20:00 +08:00
54 lines
2.7 KiB
Markdown
54 lines
2.7 KiB
Markdown
---
|
||
category: Components
|
||
type: Data Display
|
||
cols: 1
|
||
title: Calendar
|
||
cover: https://gw.alipayobjects.com/zos/antfincdn/dPQmLq08DI/Calendar.svg
|
||
---
|
||
|
||
Container for displaying data in calendar form.
|
||
|
||
## When To Use
|
||
|
||
When data is in the form of dates, such as schedules, timetables, prices calendar, lunar calendar. This component also supports Year/Month switch.
|
||
|
||
## API
|
||
|
||
**Note:** Part of the Calendar's locale is read from `value`. So, please set the locale of `moment` correctly.
|
||
|
||
```jsx
|
||
// The default locale is en-US, if you want to use other locale, just set locale in entry file globally.
|
||
// import moment from 'moment';
|
||
// import 'moment/locale/zh-cn';
|
||
// moment.locale('zh-cn');
|
||
|
||
<Calendar
|
||
dateCellRender={dateCellRender}
|
||
monthCellRender={monthCellRender}
|
||
onPanelChange={onPanelChange}
|
||
onSelect={onSelect}
|
||
/>
|
||
```
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| dateCellRender | Customize the display of the date cell, the returned content will be appended to the cell | function(date: moment): ReactNode | - | |
|
||
| dateFullCellRender | Customize the display of the date cell, the returned content will override the cell | function(date: moment): ReactNode | - | |
|
||
| defaultValue | The date selected by default | [moment](http://momentjs.com/) | - | |
|
||
| disabledDate | Function that specifies the dates that cannot be selected | (currentDate: moment) => boolean | - | |
|
||
| fullscreen | Whether to display in full-screen | boolean | true | |
|
||
| locale | The calendar's locale | object | [(default)](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) | |
|
||
| mode | The display mode of the calendar | `month` \| `year` | `month` | |
|
||
| monthCellRender | Customize the display of the month cell, the returned content will be appended to the cell | function(date: moment): ReactNode | - | |
|
||
| monthFullCellRender | Customize the display of the month cell, the returned content will override the cell | function(date: moment): ReactNode | - | |
|
||
| validRange | To set valid range | \[[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | |
|
||
| value | The current selected date | [moment](http://momentjs.com/) | - | |
|
||
| onPanelChange | Callback for when panel changes | function(date: moment, mode: string) | - | |
|
||
| onSelect | Callback for when a date is selected | function(date: moment） | - | |
|
||
| onChange | Callback for when date changes | function(date: moment） | - | |
|
||
| headerRender | Render custom header in panel | function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) | - | |
|
||
|
||
## FAQ
|
||
|
||
- [How to use Calendar with customize date library like dayjs](/docs/react/replace-moment#Calendar)
|