

<DemoTitle title="DatePicker" desc="输入或选择时间的控件。">
#### API

<AntdApiRef url="https://ant.design/components/date-picker-cn/#api"></AntdApiRef>


## antd API

通用属性参考：[通用属性](/docs/react/common-props)

日期类组件包括以下五种形式。


- DatePicker
- DatePicker[picker="month"]
- DatePicker[picker="week"]
- DatePicker[picker="year"]
- DatePicker[picker="quarter"] (4.1.0 新增)
- RangePicker

### 国际化配置

默认配置为 en-US，如果你需要设置其他语言，推荐在入口处使用我们提供的国际化组件，详见：[ConfigProvider 国际化](https://ant.design/components/config-provider-cn/)。

如有特殊需求（仅修改单一组件的语言），请使用 locale 参数，参考：[默认配置](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json)。


```jsx
// 默认语言为 en-US，如果你需要设置其他语言，推荐在入口文件全局设置 locale
// 确保还导入相关的 dayjs 文件，否则所有文本的区域设置都不会更改（例如范围选择器月份）
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>;
```


<!-- prettier-ignore -->
<Container type="warning">
在搭配 Next.js 的 App Router 使用时，注意在引入 dayjs 的 locale 文件时加上 `'use client'`。这是由于 Ant Design 的组件都是客户端组件，在 RSC 中引入 dayjs 的 locale 文件将不会在客户端生效。
</Container>
### 共同的 API

以下 API 为 DatePicker、 RangePicker 共享的 API。

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| allowClear | 自定义清除按钮 | boolean \| { clearIcon?: ReactNode } | true | 5.8.0: 支持对象类型 | 
| autoFocus | 自动获取焦点 | boolean | false |  | 
| className | 选择器 className | string | - |  | 
| dateRender | 自定义日期单元格的内容，5.4.0 起用  | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 | 
| cellRender | 自定义单元格的内容 | (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 | 自定义面板 | Record | - | 5.14.0 | 
| defaultOpen | 是否默认展开控制弹层 | boolean | - |  | 
| disabled | 禁用 | boolean | false |  | 
| disabledDate | 不可选择的日期 | (currentDate: dayjs, info: { from?: dayjs, type: Picker }) => boolean | - | info | 
| format | 设置日期格式，为数组时支持多格式匹配，展示以第一个为准。配置参考  |  |  |  | 
| order | 多选、范围时是否自动排序 | boolean | true | 5.14.0 | 
| preserveInvalidOnBlur | 失去焦点是否要清空输入框内无效内容 | boolean | false | 5.14.0 | 
| getPopupContainer | 定义浮层的容器，默认为 body 上新建 div | function(trigger) | - |  | 
| inputReadOnly | 设置输入框为只读（避免在移动设备上打开虚拟键盘） | boolean | false |  | 
| locale | 国际化配置 | object |  |  | 
| minDate | 最小日期，同样会限制面板的切换范围 | dayjs | - | 5.14.0 | 
| maxDate | 最大日期，同样会限制面板的切换范围 | dayjs | - | 5.14.0 | 
| mode | 日期面板的状态（ | time | - |  | 
| needConfirm | 是否需要确认按钮，为  | boolean | - | 5.14.0 | 
| nextIcon | 自定义下一个图标 | ReactNode | - | 4.17.0 | 
| open | 控制弹层是否展开 | boolean | - |  | 
| panelRender | 自定义渲染面板 | (panelNode) => ReactNode | - | 4.5.0 | 
| picker | 设置选择器类型 | date | date | quarter | 
| placeholder | 输入框提示文字 | string \| [string, string] | - |  | 
| placement | 选择框弹出的位置 | bottomLeft | bottomLeft |  | 
| prefix | 自定义前缀 | ReactNode | - | 5.22.0 | 
| prevIcon | 自定义上一个图标 | ReactNode | - | 4.17.0 | 
| presets | 预设时间范围快捷选择, 自  | { label: React.ReactNode, value: Dayjs \| (() => Dayjs) }[] | - |  | 
| size | 输入框大小， | large | - |  | 
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | 
| style | 自定义输入框样式 | CSSProperties | {} |  | 
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - |  | 
| superNextIcon | 自定义  | ReactNode | - | 4.17.0 | 
| superPrevIcon | 自定义  | ReactNode | - | 4.17.0 | 
| variant | 形态变体 | outlined | outlined | 5.13.0 \|  | 
| onOpenChange | 弹出日历和关闭日历的回调 | function(open) | - |  | 
| onPanelChange | 日历面板切换的回调 | function(value, mode) | - |  | 


### 共同的方法

| 名称 | 描述 | 版本 | 
|--------|--------|--------|
| blur() | 移除焦点 |  | 
| focus() | 获取焦点 |  | 


### DatePicker

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultPickerValue | 默认面板日期，每次面板打开时会被重置到该日期 |  | - | 5.14.0 | 
| defaultValue | 默认日期，如果开始时间或结束时间为  |  | - |  | 
| disabledTime | 不可选择的时间 | function(date) | - |  | 
| format | 展示的日期格式，配置参考  |  | YYYY-MM-DD |  | 
| multiple | 是否为多选，不支持  | boolean | false | 5.14.0 | 
| pickerValue | 面板日期，可以用于受控切换面板所在日期。配合  |  | - | 5.14.0 | 
| renderExtraFooter | 在面板中添加额外的页脚 | (mode) => React.ReactNode | - |  | 
| showNow | 显示当前日期时间的快捷选择 | boolean | - |  | 
| showTime | 增加时间选择功能 | Object \| boolean |  |  | 
| showTime.defaultValue | 设置用户选择日期时默认的时分秒， |  | dayjs() |  | 
| showWeek | DatePicker 下展示当前周 | boolean | false | 5.14.0 | 
| value | 日期 |  | - |  | 
| onChange | 时间发生变化的回调 | function(date: dayjs, dateString: string) | - |  | 
| onOk | 点击确定按钮的回调 | function() | - |  | 
| onPanelChange | 日期面板变化时的回调 | function(value, mode) | - |  | 


### DatePicker[picker=year]

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultValue | 默认日期 |  | - |  | 
| format | 展示的日期格式，配置参考  |  | YYYY |  | 
| multiple | 是否为多选 | boolean | false | 5.14.0 | 
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |  | 
| value | 日期 |  | - |  | 
| onChange | 时间发生变化的回调，发生在用户选择时间时 | function(date: dayjs, dateString: string) | - |  | 


### DatePicker[picker=quarter]

`4.1.0` 新增。

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultValue | 默认日期 |  | - |  | 
| format | 展示的日期格式，配置参考  |  | YYYY-\QQ |  | 
| multiple | 是否为多选 | boolean | false | 5.14.0 | 
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |  | 
| value | 日期 |  | - |  | 
| onChange | 时间发生变化的回调，发生在用户选择时间时 | function(date: dayjs, dateString: string) | - |  | 


### DatePicker[picker=month]

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultValue | 默认日期 |  | - |  | 
| format | 展示的日期格式，配置参考  |  | YYYY-MM |  | 
| multiple | 是否为多选 | boolean | false | 5.14.0 | 
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |  | 
| value | 日期 |  | - |  | 
| onChange | 时间发生变化的回调，发生在用户选择时间时 | function(date: dayjs, dateString: string) | - |  | 


### DatePicker[picker=week]

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| defaultValue | 默认日期 |  | - |  | 
| format | 展示的日期格式，配置参考  |  | YYYY-wo |  | 
| multiple | 是否为多选 | boolean | false | 5.14.0 | 
| renderExtraFooter | 在面板中添加额外的页脚 | (mode) => React.ReactNode | - |  | 
| value | 日期 |  | - |  | 
| onChange | 时间发生变化的回调，发生在用户选择时间时 | function(date: dayjs, dateString: string) | - |  | 
| showWeek | DatePicker 下展示当前周 | boolean | true | 5.14.0 | 


### RangePicker

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| allowEmpty | 允许起始项部分为空 | [boolean, boolean] | [false, false] |  | 
| cellRender | 自定义单元格的内容。 | (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 | 自定义日期单元格的内容，5.4.0 起用  | function(currentDate: dayjs, today: dayjs) => React.ReactNode | - | < 5.4.0 | 
| defaultPickerValue | 默认面板日期，每次面板打开时会被重置到该日期 |  | - | 5.14.0 | 
| defaultValue | 默认日期 |  | - |  | 
| disabled | 禁用起始项 | [boolean, boolean] | - |  | 
| disabledTime | 不可选择的时间 | function(date: dayjs, partial:  | - | info.from | 
| format | 展示的日期格式，配置参考  |  | YYYY-MM-DD HH:mm:ss |  | 
| id | 设置输入框  | { start?: string, end?: string } | - | 5.14.0 | 
| pickerValue | 面板日期，可以用于受控切换面板所在日期。配合  |  | - | 5.14.0 | 
| presets | 预设时间范围快捷选择，自  | { label: React.ReactNode, value: (Dayjs \| (() => Dayjs))[] }[] | - |  | 
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |  | 
| separator | 设置分隔符 | React.ReactNode |  |  | 
| showTime | 增加时间选择功能 | Object\|boolean |  |  | 
| showTime.defaultValue | 设置用户选择日期时默认的时分秒， |  | [dayjs(), dayjs()] |  | 
| value | 日期 |  | - |  | 
| onCalendarChange | 待选日期发生变化的回调。 | function(dates: [dayjs, dayjs], dateStrings: [string, string], info: { range: | - |  | 
| onChange | 日期范围发生变化的回调 | function(dates: [dayjs, dayjs], dateStrings: [string, string]) | - |  | 
| onFocus | 聚焦时回调 | function(event, { range: 'start' \| 'end' }) | - | range | 
| onBlur | 失焦时回调 | function(event, { range: 'start' \| 'end' }) | - | range | 


#### formatType


```typescript
import type { Dayjs } from 'dayjs';

type Generic = string;
type GenericFn = (value: Dayjs) => string;

export type FormatType =
  | Generic
  | GenericFn
  | Array
  | {
      format: string;
      type?: 'mask';
    };
```


注意：`type` 定义为 `5.14.0` 新增。