Basic
Range Picker
Switchable picker
Date Format
Choose Time
Disabled
Disabled Date & Time
Select range dates in 7 days
Preset Ranges
Extra Footer
Three Sizes
Customized Date Rendering
Bordered-less
API

DatePicker

To select or input a date.

When To Use#

By clicking the input box, you can select a date from a popup calendar.

Examples

Basic

Basic use case. Users can select or input a date in panel.

import { DatePicker, Space } from 'antd';

function onChange(date, dateString) {
  console.log(date, dateString);
}

ReactDOM.render(
  <Space direction="vertical">
    <DatePicker onChange={onChange} />
    <DatePicker onChange={onChange} picker="week" />
    <DatePicker onChange={onChange} picker="month" />
    <DatePicker onChange={onChange} picker="quarter" />
    <DatePicker onChange={onChange} picker="year" />
  </Space>,
  mountNode,
);

Time

Switchable picker

Switch in different types of pickers by Select.

import React, { useState } from 'react';
import { DatePicker, TimePicker, Select, Space } from 'antd';

const { Option } = Select;

function PickerWithType({ type, onChange }) {
  if (type === 'time') return <TimePicker onChange={onChange} />;
  if (type === 'date') return <DatePicker onChange={onChange} />;
  return <DatePicker picker={type} onChange={onChange} />;
}

function SwitchablePicker() {
  const [type, setType] = useState('time');
  return (
    <Space>
      <Select value={type} onChange={setType}>
        <Option value="time">Time</Option>
        <Option value="date">Date</Option>
        <Option value="week">Week</Option>
        <Option value="month">Month</Option>
        <Option value="quarter">Quarter</Option>
        <Option value="year">Year</Option>
      </Select>
      <PickerWithType type={type} onChange={value => console.log(value)} />
    </Space>
  );
}

ReactDOM.render(<SwitchablePicker />, mountNode);

Choose Time

This property provide an additional time selection. When showTime is an Object, its properties will be passed on to built-in TimePicker.

import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

function onChange(value, dateString) {
  console.log('Selected Time: ', value);
  console.log('Formatted Selected Time: ', dateString);
}

function onOk(value) {
  console.log('onOk: ', value);
}

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker showTime onChange={onChange} onOk={onOk} />
    <RangePicker
      showTime={{ format: 'HH:mm' }}
      format="YYYY-MM-DD HH:mm"
      onChange={onChange}
      onOk={onOk}
    />
  </Space>,
  mountNode,
);

Disabled Date & Time

Disabled part of dates and time by disabledDate and disabledTime respectively, and disabledTime only works with showTime.

import moment from 'moment';
import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

function range(start, end) {
  const result = [];
  for (let i = start; i < end; i++) {
    result.push(i);
  }
  return result;
}

function disabledDate(current) {
  // Can not select days before today and today
  return current && current < moment().endOf('day');
}

function disabledDateTime() {
  return {
    disabledHours: () => range(0, 24).splice(4, 20),
    disabledMinutes: () => range(30, 60),
    disabledSeconds: () => [55, 56],
  };
}

function disabledRangeTime(_, type) {
  if (type === 'start') {
    return {
      disabledHours: () => range(0, 60).splice(4, 20),
      disabledMinutes: () => range(30, 60),
      disabledSeconds: () => [55, 56],
    };
  }
  return {
    disabledHours: () => range(0, 60).splice(20, 4),
    disabledMinutes: () => range(0, 31),
    disabledSeconds: () => [55, 56],
  };
}

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker
      format="YYYY-MM-DD HH:mm:ss"
      disabledDate={disabledDate}
      disabledTime={disabledDateTime}
      showTime={{ defaultValue: moment('00:00:00', 'HH:mm:ss') }}
    />
    <DatePicker picker="month" disabledDate={disabledDate} />
    <RangePicker disabledDate={disabledDate} />
    <RangePicker
      disabledDate={disabledDate}
      disabledTime={disabledRangeTime}
      showTime={{
        hideDisabledOptions: true,
        defaultValue: [moment('00:00:00', 'HH:mm:ss'), moment('11:59:59', 'HH:mm:ss')],
      }}
      format="YYYY-MM-DD HH:mm:ss"
    />
  </Space>,
  mountNode,
);

Preset Ranges

We can set preset ranges to RangePicker to improve user experience.

import { DatePicker, Space } from 'antd';
import moment from 'moment';

const { RangePicker } = DatePicker;

function onChange(dates, dateStrings) {
  console.log('From: ', dates[0], ', to: ', dates[1]);
  console.log('From: ', dateStrings[0], ', to: ', dateStrings[1]);
}

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <RangePicker
      ranges={{
        Today: [moment(), moment()],
        'This Month': [moment().startOf('month'), moment().endOf('month')],
      }}
      onChange={onChange}
    />
    <RangePicker
      ranges={{
        Today: [moment(), moment()],
        'This Month': [moment().startOf('month'), moment().endOf('month')],
      }}
      showTime
      format="YYYY/MM/DD HH:mm:ss"
      onChange={onChange}
    />
  </Space>,
  mountNode,
);

LargeDefaultSmall

Three Sizes

The input box comes in three sizes. default will be used if size is omitted.

import { DatePicker, Radio, Space } from 'antd';

const { RangePicker } = DatePicker;

class PickerSizesDemo extends React.Component {
  state = {
    size: 'default',
  };

  handleSizeChange = e => {
    this.setState({ size: e.target.value });
  };

  render() {
    const { size } = this.state;
    return (
      <Space direction="vertical" size={12}>
        <Radio.Group value={size} onChange={this.handleSizeChange}>
          <Radio.Button value="large">Large</Radio.Button>
          <Radio.Button value="default">Default</Radio.Button>
          <Radio.Button value="small">Small</Radio.Button>
        </Radio.Group>
        <DatePicker size={size} />
        <DatePicker size={size} picker="month" />
        <RangePicker size={size} />
        <DatePicker size={size} picker="week" />
      </Space>
    );
  }
}

ReactDOM.render(<PickerSizesDemo />, mountNode);

Bordered-less

Bordered-less style component.

import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker bordered={false} />
    <DatePicker picker="week" bordered={false} />
    <DatePicker picker="month" bordered={false} />
    <DatePicker picker="year" bordered={false} />
    <RangePicker bordered={false} />
    <RangePicker picker="week" bordered={false} />
    <RangePicker picker="month" bordered={false} />
    <RangePicker picker="year" bordered={false} />
  </Space>,
  mountNode,
);

Range Picker

Set range picker type by picker prop.

import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <RangePicker />
    <RangePicker showTime />
    <RangePicker picker="week" />
    <RangePicker picker="month" />
    <RangePicker picker="year" />
  </Space>,
  mountNode,
);

Date Format

We can set the date format by format.

import { DatePicker, Space } from 'antd';
import moment from 'moment';

const { RangePicker } = DatePicker;

const dateFormat = 'YYYY/MM/DD';
const monthFormat = 'YYYY/MM';

const dateFormatList = ['DD/MM/YYYY', 'DD/MM/YY'];

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker defaultValue={moment('2015/01/01', dateFormat)} format={dateFormat} />
    <DatePicker defaultValue={moment('01/01/2015', dateFormatList[0])} format={dateFormatList} />
    <DatePicker defaultValue={moment('2015/01', monthFormat)} format={monthFormat} picker="month" />
    <RangePicker
      defaultValue={[moment('2015/01/01', dateFormat), moment('2015/01/01', dateFormat)]}
      format={dateFormat}
    />
  </Space>,
  mountNode,
);

Disabled

A disabled state of the DatePicker. You can also set as array to disable one of input.

import { DatePicker, Space } from 'antd';
import moment from 'moment';

const { RangePicker } = DatePicker;

const dateFormat = 'YYYY-MM-DD';
ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker defaultValue={moment('2015-06-06', dateFormat)} disabled />
    <DatePicker picker="month" defaultValue={moment('2015-06', 'YYYY-MM')} disabled />
    <RangePicker
      defaultValue={[moment('2015-06-06', dateFormat), moment('2015-06-06', dateFormat)]}
      disabled
    />
    <RangePicker
      defaultValue={[moment('2019-09-03', dateFormat), moment('2019-11-22', dateFormat)]}
      disabled={[false, true]}
    />
  </Space>,
  mountNode,
);

Select range dates in 7 days

A example shows how to select a dynamic range by using onCalendarChange and disabledDate.

import React, { useState } from 'react';
import { DatePicker } from 'antd';

const { RangePicker } = DatePicker;

const App = () => {
  const [dates, setDates] = useState([]);
  const disabledDate = current => {
    if (!dates || dates.length === 0) {
      return false;
    }
    const tooLate = dates[0] && current.diff(dates[0], 'days') > 7;
    const tooEarly = dates[1] && dates[1].diff(current, 'days') > 7;
    return tooEarly || tooLate;
  };

  return (
    <RangePicker
      disabledDate={disabledDate}
      onCalendarChange={value => {
        setDates(value);
      }}
    />
  );
};

ReactDOM.render(<App />, mountNode);

Extra Footer

Render extra footer in panel for customized requirements.

import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker renderExtraFooter={() => 'extra footer'} />
    <DatePicker renderExtraFooter={() => 'extra footer'} showTime />
    <RangePicker renderExtraFooter={() => 'extra footer'} />
    <RangePicker renderExtraFooter={() => 'extra footer'} showTime />
    <DatePicker renderExtraFooter={() => 'extra footer'} picker="month" />
  </Space>,
  mountNode,
);

Customized Date Rendering

We can customize the rendering of date cells in the calendar by providing a dateRender function to DatePicker.

import { DatePicker, Space } from 'antd';

const { RangePicker } = DatePicker;

ReactDOM.render(
  <Space direction="vertical" size={12}>
    <DatePicker
      dateRender={current => {
        const style = {};
        if (current.date() === 1) {
          style.border = '1px solid #1890ff';
          style.borderRadius = '50%';
        }
        return (
          <div className="ant-picker-cell-inner" style={style}>
            {current.date()}
          </div>
        );
      }}
    />
    <RangePicker
      dateRender={current => {
        const style = {};
        if (current.date() === 1) {
          style.border = '1px solid #1890ff';
          style.borderRadius = '50%';
        }
        return (
          <div className="ant-picker-cell-inner" style={style}>
            {current.date()}
          </div>
        );
      }}
    />
  </Space>,
  mountNode,
);

API#

There are five kinds of picker:

DatePicker
DatePicker[picker="month"]
DatePicker[picker="week"]
DatePicker[picker="year"]
DatePicker[picker="quarter"] (Added in 4.1.0)
RangePicker

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 'moment/locale/zh-cn';
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';
import 'moment/locale/zh-cn';
import locale from 'antd/es/locale/zh_CN';

<ConfigProvider locale={locale}>
  <DatePicker defaultValue={moment('2015-01-01', 'YYYY-MM-DD')} />
</ConfigProvider>;

Common API#

The following APIs are shared by DatePicker, RangePicker.

Property	Description	Type	Default	Version
allowClear	Whether to show clear button	boolean	true
autoFocus	If get focus when component mounted	boolean	false
className	The 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	The picker panel mode（ Cannot select year or month anymore? )	`time` \| `date` \| `month` \| `year` \| `decade`	-
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]	-
popupStyle	To customize the style of the popup calendar	CSSProperties	{}
size	The 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`	-
bordered	Whether has border style	boolean	true
suffixIcon	The custom suffix icon	ReactNode	-
style	To customize the style of the input box	CSSProperties	{}
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)	-
inputReadOnly	Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices)	boolean	false

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	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)	-
showNow	Whether to show 'Now' button on panel when `showTime` is set	boolean	-	4.4.0

DatePicker[picker=year]#

Property	Description	Type	Default
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	Callback function, can be executed when the selected time is changing	function(date: moment, dateString: string)	-

DatePicker[picker=quarter]#

Added in 4.1.0.

Property	Description	Type	Default
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-\QQ`
renderExtraFooter	Render extra footer in panel	() => React.ReactNode	-
value	To set date	moment	-
onChange	Callback function, can be executed when the selected time is changing	function(date: moment, dateString: string)	-

DatePicker[picker=month]#

Property	Description	Type	Default
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`
monthCellRender	Custom month cell content render method	function(date, locale): ReactNode	-
renderExtraFooter	Render extra footer in panel	() => React.ReactNode	-
value	To set date	moment	-
onChange	Callback function, can be executed when the selected time is changing	function(date: moment, dateString: string)	-

DatePicker[picker=week]#

Property	Description	Type	Default
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	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
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: moment, today: moment, info: { range: `start` \| `end` }) => React.ReactNode	-
defaultValue	To set default date	[moment, moment]	-
defaultPickerValue	To set default picker date	[moment, moment]	-
disabled	If disable start or end	[boolean, boolean]	-
disabledTime	To specify the time that cannot be selected	function(date: 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	The 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	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: [moment, moment], dateStrings: [string, string], info: { range:`start`\|`end` })	-
onChange	Callback function, can be executed when the selected time is changing	function(dates: [moment, moment], dateStrings: [string, string])	-

FAQ#

When set mode to DatePicker/RangePicker, cannot select year or month anymore?#

Please refer FAQ

How to use DatePicker with customize date library like dayjs?#

Please refer replace moment

Why config moment.locale globally not work?#

DatePicker default set locale as en in v4. You can config DatePicker locale prop or ConfigProvider prop instead.

How to modify start day of week?#

Please use correct language (#5605), or update moment locale config: https://codesandbox.io/s/moment-day-of-week-6dby5

moment.locale('en', {
  week: {
    dow: 1,
  },
});