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 use case. Users can select or input a date in panel.

expand codeexpand code
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

Switch in different types of pickers by Select.

expand codeexpand code
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);

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

expand codeexpand code
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 part of dates and time by disabledDate and disabledTime respectively, and disabledTime only works with showTime.

expand codeexpand code
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,
);

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

expand codeexpand code
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,
);

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

expand codeexpand code
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 style component.

expand codeexpand code
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,
);

Set range picker type by picker prop.

expand codeexpand code
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,
);

We can set the date format by format.

expand codeexpand code
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'];

const customFormat = value => {
  return `custom format: ${value.format(dateFormat)}`;
};

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}
    />
    <DatePicker defaultValue={moment('2015/01/01', dateFormat)} format={customFormat} />
  </Space>,
  mountNode,
);

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

expand codeexpand code
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,
);

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

expand codeexpand code
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 => {
        const [start, end] = value;
        const [oldStart, oldEnd] = dates;
        setDates([start || oldStart, end || oldEnd]);
      }}
    />
  );
};

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

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

expand codeexpand code
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/lib/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.

PropertyDescriptionTypeDefaultVersion
allowClearWhether to show clear buttonbooleantrue
autoFocusIf get focus when component mountedbooleanfalse
borderedWhether has border stylebooleantrue
classNameThe picker classNamestring-
dateRenderCustom rendering function for date cellsfunction(currentDate: moment, today: moment) => React.ReactNode-
disabledDetermine whether the DatePicker is disabledbooleanfalse
disabledDateSpecify the date that cannot be selected(currentDate: moment) => boolean-
dropdownClassNameTo customize the className of the popup calendarstring-
getPopupContainerTo set the container of the floating layer, while the default is to create a div element in bodyfunction(trigger)-
inputReadOnlySet the readonly attribute of the input tag (avoids virtual keyboard on touch devices)booleanfalse
localeLocalization configurationobjectdefault
modeThe picker panel mode( Cannot select year or month anymore? )time | date | month | year | decade-
openThe open state of pickerboolean-
panelRenderCustomize panel render(panelNode) => ReactNode-4.5.0
pickerSet picker typedate | week | month | quarter | yeardatequarter: 4.1.0
placeholderThe placeholder of date inputstring | [string,string]-
popupStyleTo customize the style of the popup calendarCSSProperties{}
sizeThe determine the size of the input box, the height of large and small, are 40px and 24px respectively, while default size is 32pxlarge | middle | small-
styleTo customize the style of the input boxCSSProperties{}
suffixIconThe custom suffix iconReactNode-
onOpenChangeCallback function, can be executed whether the popup calendar is popped up or closedfunction(open)-
onPanelChangeCallback when picker panel mode is changedfunction(value, mode)-

Common Methods#

NameDescriptionVersion
blur()Remove focus
focus()Get focus

DatePicker#

PropertyDescriptionTypeDefaultVersion
defaultPickerValueTo set default picker datemoment-
defaultValueTo set default date, if start time or end time is null or undefined, the date range will be an open intervalmoment-
disabledTimeTo specify the time that cannot be selectedfunction(date)-
formatTo 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, support Custom Formatstring | (value: moment) => string | (string | (value: moment) => string)[]YYYY-MM-DD
renderExtraFooterRender extra footer in panel(mode) => React.ReactNode-
showNowWhether to show 'Now' button on panel when showTime is setboolean-4.4.0
showTimeTo provide an additional time selectionobject | booleanTimePicker Options
showTime.defaultValueTo set default time of selected date, demomomentmoment()
showTodayWhether to show Today buttonbooleantrue
valueTo set datemoment-
onChangeCallback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-
onOkCallback when click ok buttonfunction()-
onPanelChangeCallback function for panel changingfunction(value, mode)-

DatePicker[picker=year]#

PropertyDescriptionTypeDefaultVersion
defaultPickerValueTo set default picker datemoment-
defaultValueTo set default datemoment-
formatTo set the date format, refer to moment.jsstringYYYY
renderExtraFooterRender extra footer in panel() => React.ReactNode-
valueTo set datemoment-
onChangeCallback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

DatePicker[picker=quarter]#

Added in 4.1.0.

PropertyDescriptionTypeDefaultVersion
defaultPickerValueTo set default picker datemoment-
defaultValueTo set default datemoment-
formatTo set the date format, refer to moment.jsstringYYYY-\QQ
renderExtraFooterRender extra footer in panel() => React.ReactNode-
valueTo set datemoment-
onChangeCallback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

DatePicker[picker=month]#

PropertyDescriptionTypeDefaultVersion
defaultPickerValueTo set default picker datemoment-
defaultValueTo set default datemoment-
formatTo set the date format, refer to moment.jsstringYYYY-MM
monthCellRenderCustom month cell content render methodfunction(date, locale): ReactNode-
renderExtraFooterRender extra footer in panel() => React.ReactNode-
valueTo set datemoment-
onChangeCallback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

DatePicker[picker=week]#

PropertyDescriptionTypeDefaultVersion
defaultPickerValueTo set default picker datemoment-
defaultValueTo set default datemoment-
formatTo set the date format, refer to moment.jsstringYYYY-wo
renderExtraFooterRender extra footer in panel(mode) => React.ReactNode-
valueTo set datemoment-
onChangeCallback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

RangePicker#

PropertyDescriptionTypeDefaultVersion
allowEmptyAllow start or end input leave empty[boolean, boolean][false, false]
dateRenderCustomize date cell. info argument is added in 4.3.0function(currentDate: moment, today: moment, info: { range: start | end }) => React.ReactNode-
defaultPickerValueTo set default picker date[moment, moment]-
defaultValueTo set default date[moment, moment]-
disabledIf disable start or end[boolean, boolean]-
disabledTimeTo specify the time that cannot be selectedfunction(date: moment, partial: start | end)-
formatTo 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 formattingstring | string[]YYYY-MM-DD HH:mm:ss
rangesThe preseted ranges for quick selection{ [range: string]: moment[] } | { [range: string]: () => moment[] }-
renderExtraFooterRender extra footer in panel() => React.ReactNode-
separatorSet separator between inputsstring~
showTimeTo provide an additional time selectionobject | booleanTimePicker Options
showTime.defaultValueTo set default time of selected date, demomoment[][moment(), moment()]
valueTo set date[moment, moment]-
onCalendarChangeCallback function, can be executed when the start time or the end time of the range is changing. info argument is added in 4.4.0function(dates: [moment, moment], dateStrings: [string, string], info: { range:start|end })-
onChangeCallback function, can be executed when the selected time is changingfunction(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

Why origin panel don't switch when using 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.

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