Importimport { DatePicker } from 'antd'; |
contributors
Importimport { DatePicker } from 'antd'; |
By clicking the input box, you can select a date from a popup calendar.
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>;
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 | Global Config |
|---|---|---|---|---|---|
| allowClear | Customize clear button | boolean | { clearIcon?: ReactNode } | true | 5.8.0: Support object type | DatePicker: 6.4.0, RangePicker: × |
Whether has border style, please use variant instead | boolean | true | - | × | |
| className | The picker className | string | - | DatePicker: 5.7.0, RangePicker: 5.11.0 | |
| classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | DatePicker: 6.0.0, RangePicker: × | |
| 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 | {} | DatePicker: 5.7.0, RangePicker: 5.11.0 | |
| styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | DatePicker: 6.0.0, RangePicker: × | |
| suffixIcon | The custom suffix icon | ReactNode | - | DatePicker: 6.3.0, RangePicker: × | |
| superNextIcon | The custom super next icon | ReactNode | - | 4.17.0 | × |
| superPrevIcon | The custom super prev icon | ReactNode | - | 4.17.0 | × |
| clearIcon | (Only supports global configuration) Custom clear icon | ReactNode | - | × | DatePicker: 6.4.0, RangePicker: × |
| variant | Variants of picker | outlined | borderless | filled | underlined | outlined | 5.13.0 | underlined: 5.24.0 | DatePicker: 5.13.0, RangePicker: 5.13.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 | - | |
| tagRender | Customize tag render, only applies when multiple is set | (props) => ReactNode | - | 6.4.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) | - |
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 | - | |
| tagRender | Customize tag render, only applies when multiple is set | (props) => ReactNode | - | 6.4.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) | - |
| 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 | - | |
| tagRender | Customize tag render, only applies when multiple is set | (props) => ReactNode | - | 6.4.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) | - |
| 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 | - | |
| tagRender | Customize tag render, only applies when multiple is set | (props) => ReactNode | - | 6.4.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) | - | |
| showWeek | Show week info when in DatePicker | boolean | true | 5.14.0 |
| Property | Description | Type | Default | Version | Global Config |
|---|---|---|---|---|---|
| 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 /> | 6.3.0 | |
| 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.
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| activeBg | Background color when the input box is activated | string | #ffffff |
| activeBorderColor | Active border color | string | #1677ff |
| activeShadow | Box-shadow when active | string | 0 0 0 2px rgba(5,145,255,0.1) |
| addonBg | Background color of addon | string | rgba(0,0,0,0.02) |
| cellActiveWithRangeBg | Background color of cell in range | string | #e6f4ff |
| cellBgDisabled | Background color of disabled cell | string | rgba(0,0,0,0.04) |
| cellHeight | Height of cell | number | 24 |
| cellHoverBg | Background color of cell hover state | string | rgba(0,0,0,0.04) |
| cellHoverWithRangeBg | Background color of hovered cell in range | string | #cbe0fd |
| cellRangeBorderColor | Border color of cell in range when picking | string | #82b4f9 |
| cellWidth | Width of cell | number | 36 |
| errorActiveShadow | Box-shadow when active in error status | string | 0 0 0 2px rgba(255,38,5,0.06) |
| hoverBg | Background color when the input box hovers | string | #ffffff |
| hoverBorderColor | Hover border color | string | #4096ff |
| inputFontSize | Font size | number | 14 |
| inputFontSizeLG | Font size of large | number | 16 |
| inputFontSizeSM | Font size of small | number | 14 |
| multipleItemBg | Background color of multiple tag | string | rgba(0,0,0,0.06) |
| multipleItemBorderColor | Border color of multiple tag | string | transparent |
| multipleItemBorderColorDisabled | Border color of multiple tag when disabled | string | transparent |
| multipleItemColorDisabled | Text color of multiple tag when disabled | string | rgba(0,0,0,0.25) |
| multipleItemHeight | Height of multiple tag | number | 24 |
| multipleItemHeightLG | Height of multiple tag with large size | number | 32 |
| multipleItemHeightSM | Height of multiple tag with small size | number | 16 |
| multipleSelectorBgDisabled | Background color of multiple selector when disabled | string | rgba(0,0,0,0.04) |
| paddingBlock | Vertical padding of input | number | 4 |
| paddingBlockLG | Vertical padding of large input | number | 7 |
| paddingBlockSM | Vertical padding of small input | number | 0 |
| paddingInline | Horizontal padding of input | number | 11 |
| paddingInlineLG | Horizontal padding of large input | number | 11 |
| paddingInlineSM | Horizontal padding of small input | number | 7 |
| presetsMaxWidth | Max width of preset area | number | 200 |
| presetsWidth | Width of preset area | number | 120 |
| textHeight | Height of cell text | number | 40 |
| timeCellHeight | Height of time cell | number | 28 |
| timeColumnHeight | Height of time column | number | 224 |
| timeColumnWidth | Width of time column | number | 56 |
| warningActiveShadow | Box-shadow when active in warning status | string | 0 0 0 2px rgba(255,215,5,0.1) |
| withoutTimeCellHeight | Height of decade/year/quarter/month/week cell | number | 66 |
| zIndexPopup | z-index of popup | number | 1050 |
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| colorBgContainer | Container background color, e.g: default button, input box, etc. Be sure not to confuse this with `colorBgElevated`. | string | #ffffff |
| colorBgContainerDisabled | Control the background color of container in disabled state. | string | rgba(0,0,0,0.04) |
| colorBgElevated | Container background color of the popup layer, in dark mode the color value of this token will be a little brighter than `colorBgContainer`. E.g: modal, pop-up, menu, etc. | string | #ffffff |
| colorBorder | Default border color, used to separate different elements, such as: form separator, card separator, etc. | string | #d9d9d9 |
| colorBorderDisabled | Control the border color of the element in the disabled state. | string | #d9d9d9 |
| colorError | Used to represent the visual elements of the operation failure, such as the error Button, error Result component, etc. | string | #ff4d4f |
| colorErrorAffix | Control the color of form control prefix/suffix in error state. | string | #ff4d4f |
| colorErrorBg | The background color of the error state. | string | #fff2f0 |
| colorErrorBgHover | The hover state background color of the error state. | string | #fff1f0 |
| colorErrorBorderHover | The hover state border color of the error state. | string | #ffa39e |
| colorErrorText | The default state of the text in the error color. | string | #ff4d4f |
| colorFillSecondary | The second level of fill color can outline the shape of the element more clearly, such as Rate, Skeleton, etc. It can also be used as the Hover state of the third level of fill color, such as Table, etc. | string | rgba(0,0,0,0.06) |
| colorFillTertiary | The third level of fill color is used to outline the shape of the element, such as Slider, Segmented, etc. If there is no emphasis requirement, it is recommended to use the third level of fill color as the default fill color. | string | rgba(0,0,0,0.04) |
| colorIcon | Weak action. Such as `allowClear` or Alert close button | string | rgba(0,0,0,0.45) |
| colorIconHover | Weak action hover color. Such as `allowClear` or Alert close button | string | rgba(0,0,0,0.88) |
| colorPrimary | Brand color is one of the most direct visual elements to reflect the characteristics and communication of the product. After you have selected the brand color, we will automatically generate a complete color palette and assign it effective design semantics. | string | #1677ff |
| colorPrimaryBorder | The stroke color under the main color gradient, used on the stroke of components such as Slider. | string | #91caff |
| colorSplit | Used as the color of separator, this color is the same as colorBorderSecondary but with transparency. | string | rgba(5,5,5,0.06) |
| colorText | Default text color which comply with W3C standards, and this color is also the darkest neutral color. | string | rgba(0,0,0,0.88) |
| colorTextDisabled | Control the color of text in disabled state. | string | rgba(0,0,0,0.25) |
| colorTextHeading | Control the font color of heading. | string | rgba(0,0,0,0.88) |
| colorTextLightSolid | Control the highlight color of text with background color, such as the text in Primary Button components. | string | #fff |
| colorTextPlaceholder | Control the color of placeholder text. | string | rgba(0,0,0,0.25) |
| colorTextQuaternary | The fourth level of text color is the lightest text color, such as form input prompt text, disabled color text, etc. | string | rgba(0,0,0,0.25) |
| colorTextTertiary | The third level of text color is generally used for descriptive text, such as form supplementary explanation text, list descriptive text, etc. | string | rgba(0,0,0,0.45) |
| colorWarning | Used to represent the warning map token, such as Notification, Alert, etc. Alert or Control component(like Input) will use these map tokens. | string | #faad14 |
| colorWarningAffix | Control the color of form control prefix/suffix in warning state. | string | #faad14 |
| colorWarningBg | The background color of the warning state. | string | #fffbe6 |
| colorWarningBgHover | The hover state background color of the warning state. | string | #fff1b8 |
| colorWarningBorderHover | The hover state border color of the warning state. | string | #ffd666 |
| colorWarningText | The default state of the text in the warning color. | string | #faad14 |
| borderRadius | Border radius of base components | number | 6 |
| borderRadiusLG | LG size border radius, used in some large border radius components, such as Card, Modal and other components. | number | 8 |
| borderRadiusSM | SM size border radius, used in small size components, such as Button, Input, Select and other input components in small size | number | 4 |
| borderRadiusXS | XS size border radius, used in some small border radius components, such as Segmented, Arrow and other components with small border radius. | number | 2 |
| boxShadowSecondary | Control the secondary box shadow style of an element. | string | 0 6px 16px 0 rgba(0,0,0,0.08), 0 3px 6px -4px rgba(0,0,0,0.12), 0 9px 28px 8px rgba(0,0,0,0.05) |
| controlHeight | The height of the basic controls such as buttons and input boxes in Ant Design | number | 32 |
| controlHeightLG | LG component height | number | 40 |
| controlHeightSM | SM component height | number | 24 |
| controlItemBgActive | Control the background color of control component item when active. | string | #e6f4ff |
| fontFamily | The font family of Ant Design prioritizes the default interface font of the system, and provides a set of alternative font libraries that are suitable for screen display to maintain the readability and readability of the font under different platforms and browsers, reflecting the friendly, stable and professional characteristics. | string | -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji' |
| fontSize | The most widely used font size in the design system, from which the text gradient will be derived. | number | 14 |
| fontSizeLG | Large font size | number | 16 |
| fontSizeSM | Small font size | number | 12 |
| fontWeightStrong | Control the font weight of heading components (such as h1, h2, h3) or selected item. | number | 600 |
| lineHeight | Line height of text. | number | 1.5714285714285714 |
| lineHeightLG | Line height of large text. | number | 1.5 |
| lineType | Border style of base components | string | solid |
| lineWidth | Border width of base components | number | 1 |
| lineWidthBold | The default line width of the outline class components, such as Button, Input, Select, etc. | number | 2 |
| marginXS | Control the margin of an element, with a small size. | number | 8 |
| marginXXS | Control the margin of an element, with the smallest size. | number | 4 |
| motionDurationMid | Motion speed, medium speed. Used for medium element animation interaction. | string | 0.2s |
| motionDurationSlow | Motion speed, slow speed. Used for large element animation interaction. | string | 0.3s |
| motionEaseInOutCirc | Preset motion curve. | string | |
| motionEaseInQuint | Preset motion curve. | string | |
| motionEaseOutCirc | Preset motion curve. | string | |
| motionEaseOutQuint | Preset motion curve. | string | |
| padding | Control the padding of the element. | number | 16 |
| paddingSM | Control the small padding of the element. | number | 12 |
| paddingXS | Control the extra small padding of the element. | number | 8 |
| paddingXXS | Control the extra extra small padding of the element. | number | 4 |
| sizePopupArrow | The size of the component arrow | number | 16 |
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?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.