2016-06-19 11:17:09 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Data Entry
2016-09-09 13:55:21 +08:00
title: DatePicker
2023-02-20 10:51:18 +08:00
description: To select or input a date.
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*xXA9TJ8BTioAAAAAAAAAAAAADrJ8AQ/original
2023-02-09 22:17:31 +08:00
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*3OpRQKcygo8AAAAAAAAAAAAADrJ8AQ/original
2022-11-09 12:28:04 +08:00
demo:
cols: 2
2016-06-19 11:17:09 +08:00
---
## When To Use
By clicking the input box, you can select a date from a popup calendar.
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/basic.tsx" > Basic< / code >
< code src = "./demo/range-picker.tsx" > Range Picker< / code >
< code src = "./demo/switchable.tsx" > Switchable picker< / code >
< code src = "./demo/format.tsx" > Date Format< / code >
< code src = "./demo/time.tsx" > Choose Time< / code >
< code src = "./demo/disabled.tsx" > Disabled< / code >
< code src = "./demo/disabled-date.tsx" > Disabled Date & Time< / code >
< code src = "./demo/select-in-range.tsx" > Select range dates in 7 days< / code >
2023-02-23 21:56:43 +08:00
< code src = "./demo/preset-ranges.tsx" > Preset Ranges< / code >
2022-11-09 12:28:04 +08:00
< code src = "./demo/extra-footer.tsx" > Extra Footer< / code >
< code src = "./demo/size.tsx" > Three Sizes< / code >
< code src = "./demo/date-render.tsx" > Customized Date Rendering< / code >
< code src = "./demo/status.tsx" > Status< / code >
< code src = "./demo/bordered.tsx" > Bordered-less< / code >
< code src = "./demo/placement.tsx" > Placement< / code >
< code src = "./demo/mode.tsx" debug > Controlled Panels< / code >
< code src = "./demo/start-end.tsx" debug > Customized Range Picker< / code >
< code src = "./demo/suffix.tsx" debug > Suffix< / code >
< code src = "./demo/render-panel.tsx" debug > \_InternalPanelDoNotUseOrYouWillBeFired</ code >
2016-06-19 11:17:09 +08:00
## API
2019-12-11 23:32:19 +08:00
There are five kinds of picker:
2016-11-14 19:13:37 +08:00
2017-10-25 10:25:44 +08:00
- DatePicker
2020-07-23 11:25:17 +08:00
- DatePicker\[picker="month"]
- DatePicker\[picker="week"]
- DatePicker\[picker="year"]
- DatePicker\[picker="quarter"] (Added in 4.1.0)
2017-10-25 10:25:44 +08:00
- RangePicker
2016-11-14 19:13:37 +08:00
2018-05-21 21:51:39 +08:00
### Localization
2020-05-15 17:18:55 +08:00
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 ](https://ant.design/components/config-provider/ ).
2018-05-21 21:51:39 +08:00
If there are special needs (only modifying single component language), Please use the property: local. Example: [default ](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json ).
```jsx
2022-02-14 14:40:40 +08:00
import 'dayjs/locale/zh-cn';
2019-08-05 15:29:26 +08:00
import locale from 'antd/es/date-picker/locale/zh_CN';
2018-05-21 21:51:39 +08:00
2019-05-07 14:57:32 +08:00
< DatePicker locale = {locale} / > ;
2018-05-21 21:51:39 +08:00
```
2016-09-09 13:55:21 +08:00
```jsx
2018-11-15 16:32:12 +08:00
// The default locale is en-US, if you want to use other locale, just set locale in entry file globally.
2022-02-14 14:40:40 +08:00
import dayjs from 'dayjs';
import 'dayjs/locale/zh-cn';
2022-10-26 14:38:54 +08:00
import locale from 'antd/locale/zh_CN';
2016-11-02 13:47:05 +08:00
2020-07-30 13:56:18 +08:00
< ConfigProvider locale = {locale} >
2022-02-14 14:40:40 +08:00
< DatePicker defaultValue = {dayjs('2015-01-01', ' YYYY-MM-DD ' ) } / >
2020-07-30 13:56:18 +08:00
< / ConfigProvider > ;
2016-06-19 11:17:09 +08:00
```
2016-10-28 10:32:09 +08:00
### Common API
2020-07-23 11:25:17 +08:00
The following APIs are shared by DatePicker, RangePicker.
2016-10-28 10:32:09 +08:00
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| allowClear | Whether to show clear button | boolean | true | |
| autoFocus | If get focus when component mounted | boolean | false | |
| bordered | Whether has border style | boolean | true | |
| className | The picker className | string | - | |
| dateRender | Custom rendering function for date cells | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | |
| disabled | Determine whether the DatePicker is disabled | boolean | false | |
| disabledDate | Specify the date that cannot be selected | (currentDate: dayjs) => boolean | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format, support multi-format matching when it is an array, display the first one shall prevail. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ). for example: [Custom Format ](#components-date-picker-demo-format ) | [formatType ](#formattype ) | [rc-picker ](https://github.com/react-component/picker/blob/f512f18ed59d6791280d1c3d7d37abbb9867eb0b/src/utils/uiUtil.ts#L155-L177 ) | |
2022-11-17 17:31:26 +08:00
| popupClassName | To customize the className of the popup calendar | string | - | 4.23.0 |
| getPopupContainer | To set the container of the floating layer, while the default is to create a `div` element in `body` | function(trigger) | - | |
| inputReadOnly | Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices) | boolean | false | |
| locale | Localization configuration | object | [default ](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json ) | |
2022-12-22 14:12:26 +08:00
| mode | The picker panel mode( [Cannot select year or month anymore? ](/docs/react/faq#when-set-mode-to-datepickerrangepicker-cannot-select-year-or-month-anymore ) ) | `time` \| `date` \| `month` \| `year` \| `decade` | - | |
2022-11-17 17:31:26 +08:00
| nextIcon | The custom next icon | ReactNode | - | 4.17.0 |
| open | The open state of picker | boolean | - | |
| panelRender | Customize panel render | (panelNode) => ReactNode | - | 4.5.0 |
| picker | Set picker type | `date` \| `week` \| `month` \| `quarter` \| `year` | `date` | `quarter` : 4.1.0 |
| placeholder | The placeholder of date input | string \| \[string,string] | - | |
| placement | The position where the selection box pops up | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | |
| popupStyle | To customize the style of the popup calendar | CSSProperties | {} | |
| presets | The preset ranges for quick selection | { label: React.ReactNode, value: [dayjs ](https://day.js.org/ ) }[] | - | |
| prevIcon | The custom prev icon | ReactNode | - | 4.17.0 |
| size | To determine the size of the input box, the height of `large` and `small` , are 40px and 24px respectively, while default size is 32px | `large` \| `middle` \| `small` | - | |
| status | Set validation status | 'error' \| 'warning' | - | 4.19.0 |
| style | To customize the style of the input box | CSSProperties | {} | |
| suffixIcon | The custom suffix icon | ReactNode | - | |
| superNextIcon | The custom super next icon | ReactNode | - | 4.17.0 |
| superPrevIcon | The custom super prev icon | ReactNode | - | 4.17.0 |
| onOpenChange | Callback function, can be executed whether the popup calendar is popped up or closed | function(open) | - | |
| onPanelChange | Callback when picker panel mode is changed | function(value, mode) | - | |
2016-10-28 10:32:09 +08:00
2017-12-01 19:28:41 +08:00
### Common Methods
2021-05-24 16:24:00 +08:00
| Name | Description | Version |
| ------- | ------------ | ------- |
| blur() | Remove focus | |
| focus() | Get focus | |
2017-12-01 19:28:41 +08:00
2016-10-28 10:32:09 +08:00
### DatePicker
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| defaultPickerValue | To set default picker date | [dayjs ](https://day.js.org/ ) | - | |
| defaultValue | To set default date, if start time or end time is null or undefined, the date range will be an open interval | [dayjs ](https://day.js.org/ ) | - | |
| disabledTime | To specify the time that cannot be selected | function(date) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY-MM-DD` | |
2022-11-17 17:31:26 +08:00
| renderExtraFooter | Render extra footer in panel | (mode) => React.ReactNode | - | |
| showNow | Whether to show 'Now' button on panel when `showTime` is set | boolean | - | 4.4.0 |
2022-12-22 14:12:26 +08:00
| showTime | To provide an additional time selection | object \| boolean | [TimePicker Options ](/components/time-picker/#api ) | |
2022-11-17 17:31:26 +08:00
| showTime.defaultValue | To set default time of selected date, [demo ](#components-date-picker-demo-disabled-date ) | [dayjs ](https://day.js.org/ ) | dayjs() | |
| showToday | Whether to show `Today` button | boolean | true | |
| value | To set date | [dayjs ](https://day.js.org/ ) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs, dateString: string) | - | |
| onOk | Callback when click ok button | function() | - | |
| onPanelChange | Callback function for panel changing | function(value, mode) | - | |
2016-06-19 11:17:09 +08:00
2020-07-23 11:25:17 +08:00
### DatePicker\[picker=year]
2019-12-11 23:32:19 +08:00
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| defaultPickerValue | To set default picker date | [dayjs ](https://day.js.org/ ) | - | |
| defaultValue | To set default date | [dayjs ](https://day.js.org/ ) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY` | |
2022-11-17 17:31:26 +08:00
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | [dayjs ](https://day.js.org/ ) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs, dateString: string) | - | |
2019-12-11 23:32:19 +08:00
2020-07-23 11:25:17 +08:00
### DatePicker\[picker=quarter]
2020-03-21 22:43:04 +08:00
Added in `4.1.0` .
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| defaultPickerValue | To set default picker date | [dayjs ](https://day.js.org/ ) | - | |
| defaultValue | To set default date | [dayjs ](https://day.js.org/ ) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY-\QQ` | |
2022-11-17 17:31:26 +08:00
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | [dayjs ](https://day.js.org/ ) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs, dateString: string) | - | |
2020-03-21 22:43:04 +08:00
2020-07-23 11:25:17 +08:00
### DatePicker\[picker=month]
2016-06-19 11:17:09 +08:00
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| defaultPickerValue | To set default picker date | [dayjs ](https://day.js.org/ ) | - | |
| defaultValue | To set default date | [dayjs ](https://day.js.org/ ) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY-MM` | |
2022-11-17 17:31:26 +08:00
| monthCellRender | Custom month cell content render method | function(date, locale): ReactNode | - | |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | [dayjs ](https://day.js.org/ ) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs, dateString: string) | - | |
2016-06-19 11:17:09 +08:00
2020-07-23 11:25:17 +08:00
### DatePicker\[picker=week]
2017-08-31 20:44:22 +08:00
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| defaultPickerValue | To set default picker date | [dayjs ](https://day.js.org/ ) | - | |
| defaultValue | To set default date | [dayjs ](https://day.js.org/ ) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY-wo` | |
2022-11-17 17:31:26 +08:00
| renderExtraFooter | Render extra footer in panel | (mode) => React.ReactNode | - | |
| value | To set date | [dayjs ](https://day.js.org/ ) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs, dateString: string) | - | |
2017-08-31 20:44:22 +08:00
2016-06-19 11:17:09 +08:00
### RangePicker
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| allowEmpty | Allow start or end input leave empty | \[boolean, boolean] | \[false, false] | |
| dateRender | Customize date cell. `info` argument is added in 4.3.0 | function(currentDate: dayjs, today: dayjs, info: { range: `start` \| `end` }) => React.ReactNode | - | |
| defaultPickerValue | To set default picker date | \[[dayjs ](https://day.js.org/ ), [dayjs ](https://day.js.org/ )] | - | |
| defaultValue | To set default date | \[[dayjs ](https://day.js.org/ ), [dayjs ](https://day.js.org/ )] | - | |
| disabled | If disable start or end | \[boolean, boolean] | - | |
| disabledTime | To specify the time that cannot be selected | function(date: dayjs, partial: `start` \| `end` ) | - | |
2023-03-16 11:16:26 +08:00
| format | To set the date format. refer to [dayjs#format ](https://day.js.org/docs/en/display/format ) | [formatType ](#formattype ) | `YYYY-MM-DD HH:mm:ss` | |
2022-11-17 17:31:26 +08:00
| presets | The preset ranges for quick selection | { label: React.ReactNode, value: [dayjs ](https://day.js.org/ )\[] }[] | - | |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| separator | Set separator between inputs | React.ReactNode | `<SwapRightOutlined />` | |
2022-12-22 14:12:26 +08:00
| showTime | To provide an additional time selection | object \| boolean | [TimePicker Options ](/components/time-picker/#api ) | |
2022-11-17 17:31:26 +08:00
| showTime.defaultValue | To set default time of selected date, [demo ](#components-date-picker-demo-disabled-date ) | [dayjs ](https://day.js.org/ )\[] | \[dayjs(), dayjs()] | |
| value | To set date | \[[dayjs ](https://day.js.org/ ), [dayjs ](https://day.js.org/ )] | - | |
| onCalendarChange | Callback function, can be executed when the start time or the end time of the range is changing. `info` argument is added in 4.4.0 | function(dates: \[dayjs, dayjs], dateStrings: \[string, string], info: { range:`start`\|`end` }) | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(dates: \[dayjs, dayjs], dateStrings: \[string, string]) | - | |
2016-06-19 11:17:09 +08:00
2023-03-16 11:16:26 +08:00
#### formatType
```typescript
import type { Dayjs } from 'dayjs';
type Generic = string;
type GenericFn = (value: Dayjs) => string;
export type FormatType = Generic | GenericFn | Array< Generic | GenericFn > ;
```
2019-06-05 20:31:15 +08:00
## FAQ
2020-07-30 13:56:18 +08:00
### When set mode to DatePicker/RangePicker, cannot select year or month anymore?
2020-01-02 16:05:59 +08:00
2022-12-22 14:12:26 +08:00
Please refer [FAQ ](/docs/react/faq#when-set-mode-to-datepickerrangepicker-cannot-select-year-or-month-anymore )
2020-05-31 01:01:53 +08:00
2020-07-30 13:56:18 +08:00
### How to use DatePicker with customize date library like dayjs?
2020-05-31 01:01:53 +08:00
2022-12-22 14:12:26 +08:00
Please refer [Use custom date library ](/docs/react/use-custom-date-library#datepicker )
2020-05-31 01:01:53 +08:00
2022-06-13 14:03:43 +08:00
### Why config dayjs.locale globally not work?
2020-07-30 13:56:18 +08:00
DatePicker default set `locale` as `en` in v4. You can config DatePicker `locale` prop or [ConfigProvider `locale` ](/components/config-provider ) prop instead.
2022-07-12 13:10:20 +08:00
#### Date-related components locale is not working?
2022-12-22 14:12:26 +08:00
See FAQ [Date-related-components-locale-is-not-working? ](/docs/react/faq#date-related-components-locale-is-not-working )
2022-07-12 13:10:20 +08:00
2020-07-30 13:56:18 +08:00
### How to modify start day of week?
2022-06-13 14:03:43 +08:00
Please use correct [language ](/docs/react/i18n ) ([#5605](https://github.com/ant-design/ant-design/issues/5605)), or update dayjs `locale` config:
2021-07-28 18:34:37 +08:00
2022-11-25 15:58:56 +08:00
- Example: < https: // codesandbox . io / s / dayjs-day-of-week-x9tuj2 ? file = /demo.tsx >
2020-07-30 13:56:18 +08:00
```js
2022-11-25 15:58:56 +08:00
import dayjs from 'dayjs';
import 'dayjs/locale/zh-cn';
import 'dayjs/plugin/updateLocale';
dayjs.updateLocale('zh-cn', {
weekStart: 0,
2020-07-30 13:56:18 +08:00
});
```
2022-10-26 22:04:26 +08:00
### Why origin panel don't switch when using `panelRender`?
2022-10-26 23:50:13 +08:00
When you change the layout of nodes by `panelRender` , React will unmount and re-mount it which reset the component state. You should keep the layout stable. Please ref [#27263 ](https://github.com/ant-design/ant-design/issues/27263 ) for more info.