mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 01:19:45 +08:00
06ba40e860
close #19859
9.1 KiB
9.1 KiB
category | type | title |
---|---|---|
Components | Data Entry | DatePicker |
To select or input a date.
When To Use
By clicking the input box, you can select a date from a popup calendar.
API
There are five kinds of picker:
- DatePicker
- MonthPicker
- RangePicker
- WeekPicker
- YearPicker
Localization
The default locale is en-US, if you need to use other languages, recommend to use internationalized components provided by us at the entrance. Look at: ConfigProvider.
If there are special needs (only modifying single component language), Please use the property: local. Example: default.
import locale from 'antd/es/date-picker/locale/zh_CN';
<DatePicker locale={locale} />;
// The default locale is en-US, if you want to use other locale, just set locale in entry file globally.
import moment from 'moment';
<DatePicker defaultValue={moment('2015-01-01', 'YYYY-MM-DD')} />;
Common API
The following APIs are shared by DatePicker, YearPicker, MonthPicker, RangePicker, WeekPicker.
Property | Description | Type | Default | Version |
---|---|---|---|---|
allowClear | Whether to show clear button | boolean | true | |
autoFocus | get focus when component mounted | boolean | false | |
className | picker className | string | '' | |
dateRender | custom rendering function for date cells | function(currentDate: moment, today: moment) => React.ReactNode | - | |
disabled | determine whether the DatePicker is disabled | boolean | false | |
disabledDate | specify the date that cannot be selected | (currentDate: moment) => boolean | - | |
dropdownClassName | to customize the className of the popup calendar | string | - | |
getPopupContainer | to set the container of the floating layer, while the default is to create a div element in body |
function(trigger) | - | |
locale | localization configuration | object | default | |
mode | picker panel mode(Cannot select year or month anymore? | time | date | month | year | decade |
- | |
open | open state of picker | boolean | - | |
picker | Set picker type | date | week | month | year |
date |
|
placeholder | placeholder of date input | string|RangePicker[] | - | |
popupStyle | to customize the style of the popup calendar | object | {} | |
size | determine the size of the input box, the height of large and small , are 40px and 24px respectively, while default size is 32px |
string | - | |
bordered | whether has border style | Boolean | true | |
suffixIcon | The custom suffix icon | ReactNode | - | |
style | to customize the style of the input box | object | {} | |
onOpenChange | a callback function, can be executed whether the popup calendar is popped up or closed | function(status) | - | |
onPanelChange | callback when picker panel mode is changed | function(value, mode) | - |
Common Methods
Name | Description | Version |
---|---|---|
blur() | remove focus | |
focus() | get focus |
DatePicker
Property | Description | Type | Default | Version |
---|---|---|---|---|
defaultValue | to set default date, if start time or end time is null or undefined, the date range will be an open interval | moment | - | |
defaultPickerValue | to set default picker date | moment | - | |
disabledTime | to specify the time that cannot be selected | function(date) | - | |
format | to set the date format, refer to moment.js. When an array is provided, all values are used for parsing and first value is used for formatting. | string | string[] | "YYYY-MM-DD" | |
renderExtraFooter | render extra footer in panel | (mode) => React.ReactNode | - | |
showTime | to provide an additional time selection | object|boolean | TimePicker Options | |
showTime.defaultValue | to set default time of selected date, demo | moment | moment() | |
showToday | whether to show "Today" button | boolean | true | |
value | to set date | moment | - | |
onChange | a callback function, can be executed when the selected time is changing | function(date: moment, dateString: string) | - | |
onOk | callback when click ok button | function() | - | |
onPanelChange | Callback function for panel changing | function(value, mode) | - |
YearPicker
Property | Description | Type | Default | Version |
---|---|---|---|---|
defaultValue | to set default date | moment | - | |
defaultPickerValue | to set default picker date | moment | - | |
format | to set the date format, refer to moment.js | string | "YYYY" | |
renderExtraFooter | render extra footer in panel | () => React.ReactNode | - | |
value | to set date | moment | - | |
onChange | a callback function, can be executed when the selected time is changing | function(date: moment, dateString: string) | - |
MonthPicker
Property | Description | Type | Default | Version |
---|---|---|---|---|
defaultValue | to set default date | moment | - | |
defaultPickerValue | to set default picker date | moment | - | |
format | to set the date format, refer to moment.js | string | "YYYY-MM" | |
monthCellContentRender | Custom month cell content render method | function(date, locale): ReactNode | - | |
renderExtraFooter | render extra footer in panel | () => React.ReactNode | - | |
value | to set date | moment | - | |
onChange | a callback function, can be executed when the selected time is changing | function(date: moment, dateString: string) | - |
WeekPicker
Property | Description | Type | Default | Version |
---|---|---|---|---|
defaultValue | to set default date | moment | - | |
defaultPickerValue | to set default picker date | moment | - | |
format | to set the date format, refer to moment.js | string | "YYYY-wo" | |
value | to set date | moment | - | |
onChange | a callback function, can be executed when the selected time is changing | function(date: moment, dateString: string) | - | |
renderExtraFooter | render extra footer in panel | (mode) => React.ReactNode | - |
RangePicker
Property | Description | Type | Default | Version |
---|---|---|---|---|
allowEmpty | Allow start or end input leave empty | [boolean, boolean] | [false, false] | |
defaultValue | to set default date | [moment, moment] | - | |
defaultPickerValue | to set default picker date | [moment, moment] | - | |
disabled | disable start or end | [boolean, boolean] | - | |
disabledTime | to specify the time that cannot be selected | function(dates: [moment, moment], partial: `'start' | 'end'`) | - |
format | to set the date format, refer to moment.js. When an array is provided, all values are used for parsing and first value is used for formatting. | string | string[] | "YYYY-MM-DD HH:mm:ss" | |
ranges | preseted ranges for quick selection | { [range: string]: moment[] } | { [range: string]: () => moment[] } | - | |
renderExtraFooter | render extra footer in panel | () => React.ReactNode | - | |
separator | set separator between inputs | string | '~' | |
showTime | to provide an additional time selection | object|boolean | TimePicker Options | |
showTime.defaultValue | to set default time of selected date, demo | moment[] | [moment(), moment()] | |
value | to set date | [moment, moment] | - | |
onCalendarChange | a callback function, can be executed when the start time or the end time of the range is changing | function(dates: [moment, moment], dateStrings: [string, string]) | - | |
onChange | a callback function, can be executed when the selected time is changing | function(dates: [moment, moment], dateStrings: [string, string]) | - |