components/date-picker/index.en-US.md
By clicking the input box, you can select a date from a popup calendar.
<code src="./demo/basic.tsx">Basic</code> <code src="./demo/range-picker.tsx">Range Picker</code> <code src="./demo/multiple.tsx" version="5.14.0">Multiple</code> <code src="./demo/multiple-debug.tsx" debug>Multiple Debug</code> <code src="./demo/needConfirm.tsx" version="5.14.0">Need Confirm</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/mask.tsx" version="5.14.0">Mask Format</code> <code src="./demo/date-range.tsx" version="5.14.0">Limit Date Range</code> <code src="./demo/disabled.tsx">Disabled</code> <code src="./demo/disabled-date.tsx">Disabled Date & Time</code> <code src="./demo/allow-empty.tsx">Allow Empty</code> <code src="./demo/select-in-range.tsx">Select range dates</code> <code src="./demo/preset-ranges.tsx">Preset Ranges</code> <code src="./demo/extra-footer.tsx">Extra Footer</code> <code src="./demo/size.tsx">Three Sizes</code> <code src="./demo/cell-render.tsx">Customized Cell Rendering</code> <code src="./demo/components.tsx" version="5.14.0">Customize Panel</code> <code src="./demo/external-panel.tsx">External use panel</code> <code src="./demo/buddhist-era.tsx" version="5.14.0">Buddhist Era</code> <code src="./demo/status.tsx">Status</code> <code src="./demo/variant.tsx" version="5.13.0">Variants</code> <code src="./demo/style-class.tsx" version="6.0.0">Custom semantic dom styling</code> <code src="./demo/filled-debug.tsx" debug>Filled Debug</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">Prefix and Suffix</code> <code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code> <code src="./demo/component-token.tsx" debug>Component Token</code> <code src="./demo/suffixIcon-debug.tsx" debug>suffixIcon</code>
Common props ref：Common props
There are five kinds of picker:
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: locale. Example: default.
// The default locale is en-US, if you want to use other locale, just set locale in entry file globally.
// Make sure you import the relevant dayjs file as well, otherwise the locale won't change for all texts (e.g. range picker months)
import locale from 'antd/locale/zh_CN';
import dayjs from 'dayjs';
import 'dayjs/locale/zh-cn';
dayjs.locale('zh-cn');
<ConfigProvider locale={locale}>
<DatePicker defaultValue={dayjs('2015-01-01', 'YYYY-MM-DD')} />
</ConfigProvider>;
:::warning
When use with Next.js App Router, make sure to add 'use client' before import locale file of dayjs. It's because all components of Ant Design only works in client, importing locale in RSC will not work.
:::
The following APIs are shared by DatePicker, RangePicker.
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| allowClear | Customize clear button | boolean | { clearIcon?: ReactNode } | true | 5.8.0: Support object type |
Whether has border style, please use variant instead | boolean | true | - | |
| className | The picker className | string | - | |
| classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | |
| dateRender | Custom rendering function for date cells, >= 5.4.0 use cellRender instead. | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 |
| cellRender | Custom rendering function for picker cells | (current: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' | 'end', type: PanelMode, locale?: Locale, subType?: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode | - | 5.4.0 |
| components | Custom panels | Record<Panel | 'input', React.ComponentType> | - | 5.14.0 |
| defaultOpen | Initial open state of picker | boolean | - | |
| disabled | Determine whether the DatePicker is disabled | boolean | false | |
| disabledDate | Specify the date that cannot be selected | (currentDate: dayjs, info: { from?: dayjs, type: Picker }) => boolean | - | info: 5.14.0 |
The className of popup calendar, please use classNames.popup.root instead | string | - | - | |
| 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. for example: Custom Format | formatType | @rc-component/picker | |
| order | Auto order date when multiple or range selection | boolean | true | 5.14.0 |
To customize the className of the popup calendar, use classNames.popup.root instead | string | - | 4.23.0 | |
| preserveInvalidOnBlur | Don't clear the input on blur even when the typed value is invalid | boolean | false | 5.14.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 | |
| minDate | The minimum date, which also limits the range of panel switching | dayjs | - | 5.14.0 |
| maxDate | The maximum date, which also limits the range of panel switching | dayjs | - | 5.14.0 |
| mode | The picker panel mode（ Cannot select year or month anymore? ) | time | date | month | year | decade | - | |
| needConfirm | Need click confirm button to trigger value change. Default false when multiple | boolean | - | 5.14.0 |
| 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 | |
To customize the style of the popup calendar, use styles.popup.root instead | CSSProperties | {} | ||
| prefix | The custom prefix | ReactNode | - | 5.22.0 |
| presets | The preset ranges for quick selection, Since 5.8.0, preset value supports callback function. | { label: React.ReactNode, value: Dayjs | (() => Dayjs) }[] | - | |
| prevIcon | The custom prev icon | ReactNode | - | 4.17.0 |
| previewValue | When the user selects the date hover option, the value of the input field undergoes a temporary change | false | hover | hover | 6.0.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 | medium | small | - | |
| status | Set validation status | 'error' | 'warning' | - | 4.19.0 |
| style | To customize the style of the input box | CSSProperties | {} | |
| styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, 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 |
| variant | Variants of picker | outlined | borderless | filled | underlined | outlined | 5.13.0 | underlined: 5.24.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) | - | |
Callback when a date is selected, please use onCalendarChange instead | function(value) | - | - |
| Name | Description | Version |
|---|---|---|
| blur() | Remove focus | |
| focus() | Get focus |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultPickerValue | Default panel date, will be reset when panel open | dayjs | - | 5.14.0 |
| defaultValue | To set default date, if start time or end time is null or undefined, the date range will be an open interval | dayjs | - | |
| disabledTime | To specify the time that cannot be selected | function(date) | - | |
| format | To set the date format. refer to dayjs#format | formatType | YYYY-MM-DD | |
| multiple | Enable multiple selection. Not support showTime | boolean | false | 5.14.0 |
| pickerValue | Panel date. Used for controlled switching of panel date. Work with onPanelChange | dayjs | - | 5.14.0 |
| renderExtraFooter | Render extra footer in panel | (mode) => React.ReactNode | - | |
| showNow | Show the fast access of current datetime | boolean | - | 4.4.0 |
| showTime | To provide an additional time selection | object | boolean | TimePicker Options | |
Use showTime.defaultOpenValue instead | dayjs | dayjs() | 5.27.3 | |
| showTime.defaultOpenValue | To set default time of selected date, demo | dayjs | dayjs() | |
| showWeek | Show week info when in DatePicker | boolean | false | 5.14.0 |
| value | To set date | dayjs | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs | null, dateString: string | null) | - | |
| onOk | Callback when click ok button | function() | - | |
| onPanelChange | Callback function for panel changing | function(value, mode) | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultValue | To set default date | dayjs | - | |
| format | To set the date format. refer to dayjs#format | formatType | YYYY | |
| multiple | Enable multiple selection | boolean | false | 5.14.0 |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | dayjs | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs | null, dateString: string | null) | - |
Added in 4.1.0.
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultValue | To set default date | dayjs | - | |
| format | To set the date format. refer to dayjs#format | formatType | YYYY-\QQ | |
| multiple | Enable multiple selection | boolean | false | 5.14.0 |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | dayjs | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs | null, dateString: string | null) | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultValue | To set default date | dayjs | - | |
| format | To set the date format. refer to dayjs#format | formatType | YYYY-MM | |
| multiple | Enable multiple selection | boolean | false | 5.14.0 |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| value | To set date | dayjs | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs | null, dateString: string | null) | - |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultValue | To set default date | dayjs | - | |
| format | To set the date format. refer to dayjs#format | formatType | YYYY-wo | |
| multiple | Enable multiple selection | boolean | false | 5.14.0 |
| renderExtraFooter | Render extra footer in panel | (mode) => React.ReactNode | - | |
| value | To set date | dayjs | - | |
| onChange | Callback function, can be executed when the selected time is changing | function(date: dayjs | null, dateString: string | null) | - | |
| showWeek | Show week info when in DatePicker | boolean | true | 5.14.0 |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| allowEmpty | Allow start or end input leave empty | [boolean, boolean] | [false, false] | |
| cellRender | Custom rendering function for picker cells | (current: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' | 'end', type: PanelMode, locale?: Locale, subType?: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode | - | 5.4.0 |
| dateRender | Custom rendering function for date cells, >= 5.4.0 use cellRender instead. | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 |
| defaultPickerValue | Default panel date, will be reset when panel open | dayjs | - | 5.14.0 |
| defaultValue | To set default date | [dayjs, dayjs] | - | |
| disabled | If disable start or end | [boolean, boolean] | - | |
| disabledTime | To specify the time that cannot be selected | function(date: dayjs, partial: start | end, info: { from?: dayjs }) | - | info.from: 5.17.0 |
| format | To set the date format. refer to dayjs#format | formatType | YYYY-MM-DD HH:mm:ss | |
| id | Config input ids | { start?: string, end?: string } | - | 5.14.0 |
| pickerValue | Panel date. Used for controlled switching of panel date. Work with onPanelChange | dayjs | - | 5.14.0 |
| presets | The preset ranges for quick selection, Since 5.8.0, preset value supports callback function. | { label: React.ReactNode, value: (Dayjs | (() => Dayjs))[] }[] | - | |
| renderExtraFooter | Render extra footer in panel | () => React.ReactNode | - | |
| separator | Set separator between inputs | React.ReactNode | <SwapRightOutlined /> | |
| showTime | To provide an additional time selection | object | boolean | TimePicker Options | |
Use showTime.defaultOpenValue instead | dayjs[] | [dayjs(), dayjs()] | 5.27.3 | |
| showTime.defaultOpenValue | To set default time of selected date, demo | dayjs[] | [dayjs(), dayjs()] | |
| value | To set date | [dayjs, dayjs] | - | |
| 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] | null, dateStrings: [string, string] | null) | - | |
| onFocus | Trigger when get focus | function(event, { range: 'start' | 'end' }) | - | range: 5.14.0 |
| onBlur | Trigger when lose focus | function(event, { range: 'start' | 'end' }) | - | range: 5.14.0 |
import type { Dayjs } from 'dayjs';
type Generic = string;
type GenericFn = (value: Dayjs) => string;
export type FormatType =
| Generic
| GenericFn
| Array<Generic | GenericFn>
| {
format: string;
type?: 'mask';
};
Note: type is added in 5.14.0.
<code src="./demo/_semantic.tsx" simplify="true"></code>
<ComponentTokenTable component="DatePicker"></ComponentTokenTable>
Please refer FAQ
After selecting the year, the system directly switches to the date panel instead of month panel. This design is intended to reduce the user's operational burden by allowing them to complete the year modification with just one click, without having to enter the month selection interface again. At the same time, it also avoids additional cognitive burden of remembering the month.
Please refer Use custom date library
DatePicker default set locale as en in v4. You can config DatePicker locale prop or ConfigProvider locale prop instead.
See FAQ Date-related-components-locale-is-not-working?
Please use correct language (#5605), or update dayjs locale config:
import dayjs from 'dayjs';
import 'dayjs/locale/zh-cn';
import updateLocale from 'dayjs/plugin/updateLocale';
dayjs.extend(updateLocale);
dayjs.updateLocale('zh-cn', {
weekStart: 0,
});
panelRender? {#faq-panel-render-switch}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 for more info.
Please refer to the blog 'Why is it so hard to disable the date?', to learn how to use it.