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 } from 'antd';
const { MonthPicker, RangePicker, WeekPicker } = DatePicker;

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

ReactDOM.render(
  <div>
    <DatePicker onChange={onChange} />
    <br />
    <MonthPicker onChange={onChange} placeholder="Select month" />
    <br />
    <RangePicker onChange={onChange} />
    <br />
    <WeekPicker onChange={onChange} placeholder="Select week" />
  </div>
, mountNode);




~

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

expand codeexpand code
import { DatePicker, Radio } from 'antd';
const { MonthPicker, RangePicker, WeekPicker } = DatePicker;

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

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

  render() {
    const { size } = this.state;
    return (
      <div>
        <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>
        <br /><br />
        <DatePicker size={size} />
        <br />
        <MonthPicker size={size} placeholder="Select Month" />
        <br />
        <RangePicker size={size} />
        <br />
        <WeekPicker size={size} placeholder="Select Week" />
      </div>
    );
  }
}

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


~

A disabled state of the DatePicker.

expand codeexpand code
import { DatePicker } from 'antd';
import moment from 'moment';
const { MonthPicker, RangePicker } = DatePicker;

const dateFormat = 'YYYY-MM-DD';
ReactDOM.render(
  <div>
    <DatePicker defaultValue={moment('2015-06-06', dateFormat)} disabled />
    <br />
    <MonthPicker defaultValue={moment('2015-06', 'YYYY-MM')} disabled />
    <br />
    <RangePicker
      defaultValue={[moment('2015-06-06', dateFormat), moment('2015-06-06', dateFormat)]}
      disabled
    />
  </div>
, mountNode);

When RangePicker does not satisfied your requirements, try to implement similar functionality with two DatePicker.

  • Use the disabledDate property to limit the start and end dates.

  • Improve user experience with open and onOpenChange.

expand codeexpand code
import { DatePicker } from 'antd';

class DateRange extends React.Component {
  state = {
    startValue: null,
    endValue: null,
    endOpen: false,
  };

  disabledStartDate = (startValue) => {
    const endValue = this.state.endValue;
    if (!startValue || !endValue) {
      return false;
    }
    return startValue.valueOf() > endValue.valueOf();
  }

  disabledEndDate = (endValue) => {
    const startValue = this.state.startValue;
    if (!endValue || !startValue) {
      return false;
    }
    return endValue.valueOf() <= startValue.valueOf();
  }

  onChange = (field, value) => {
    this.setState({
      [field]: value,
    });
  }

  onStartChange = (value) => {
    this.onChange('startValue', value);
  }

  onEndChange = (value) => {
    this.onChange('endValue', value);
  }

  handleStartOpenChange = (open) => {
    if (!open) {
      this.setState({ endOpen: true });
    }
  }

  handleEndOpenChange = (open) => {
    this.setState({ endOpen: open });
  }

  render() {
    const { startValue, endValue, endOpen } = this.state;
    return (
      <div>
        <DatePicker
          disabledDate={this.disabledStartDate}
          showTime
          format="YYYY-MM-DD HH:mm:ss"
          value={startValue}
          placeholder="Start"
          onChange={this.onStartChange}
          onOpenChange={this.handleStartOpenChange}
        />
        <DatePicker
          disabledDate={this.disabledEndDate}
          showTime
          format="YYYY-MM-DD HH:mm:ss"
          value={endValue}
          placeholder="End"
          onChange={this.onEndChange}
          open={endOpen}
          onOpenChange={this.handleEndOpenChange}
        />
      </div>
    );
  }
}

ReactDOM.render(<DateRange />, mountNode);
~

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

expand codeexpand code
import { DatePicker } from 'antd';
const { RangePicker } = DatePicker;

ReactDOM.render(
  <div>
    <DatePicker
      dateRender={(current) => {
        const style = {};
        if (current.date() === 1) {
          style.border = '1px solid #1890ff';
          style.borderRadius = '50%';
        }
        return (
          <div className="ant-calendar-date" 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-calendar-date" style={style}>
            {current.date()}
          </div>
        );
      }}
    />
  </div>
, mountNode);


~

We can set the date format by format.

expand codeexpand code
import { DatePicker } from 'antd';
import moment from 'moment';
const { MonthPicker, RangePicker } = DatePicker;

const dateFormat = 'YYYY/MM/DD';
const monthFormat = 'YYYY/MM';
ReactDOM.render(
  <div>
    <DatePicker defaultValue={moment('2015/01/01', dateFormat)} format={dateFormat} />
    <br />
    <MonthPicker defaultValue={moment('2015/01', monthFormat)} format={monthFormat} />
    <br />
    <RangePicker
      defaultValue={[moment('2015/01/01', dateFormat), moment('2015/01/01', dateFormat)]}
      format={dateFormat}
    />
  </div>
, 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 } 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(
  <div>
    <DatePicker
      showTime
      format="YYYY-MM-DD HH:mm:ss"
      placeholder="Select Time"
      onChange={onChange}
      onOk={onOk}
    />
    <br />
    <RangePicker
      showTime={{ format: 'HH:mm' }}
      format="YYYY-MM-DD HH:mm"
      placeholder={['Start Time', 'End Time']}
      onChange={onChange}
      onOk={onOk}
    />
  </div>
, 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 } from 'antd';
const { MonthPicker, 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.valueOf() < Date.now();
}

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(
  <div>
    <DatePicker
      format="YYYY-MM-DD HH:mm:ss"
      disabledDate={disabledDate}
      disabledTime={disabledDateTime}
      showTime={{ defaultValue: moment('00:00:00', 'HH:mm:ss') }}
    />
    <br />
    <MonthPicker disabledDate={disabledDate} placeholder="Select month" />
    <br />
    <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"
    />
  </div>,
  mountNode
);
~
~

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

expand codeexpand code
import { DatePicker } from 'antd';
import moment from 'moment';
const RangePicker = DatePicker.RangePicker;

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

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

~

Determing which panel to show with mode and onPanelChange.

expand codeexpand code
import { DatePicker } from 'antd';
const { RangePicker } = DatePicker;

class ControlledDatePicker extends React.Component {
  state = { mode: 'time' };

  handleOpenChange = (open) => {
    if (open) {
      this.setState({ mode: 'time' });
    }
  }

  handlePanelChange = (value, mode) => {
    this.setState({ mode });
  }

  render() {
    return (
      <DatePicker
        mode={this.state.mode}
        showTime
        onOpenChange={this.handleOpenChange}
        onPanelChange={this.handlePanelChange}
      />
    );
  }
}

class ControlledRangePicker extends React.Component {
  state = {
    mode: ['month', 'month'],
    value: [],
  };

  handlePanelChange = (value, mode) => {
    this.setState({
      value,
      mode: [
        mode[0] === 'date' ? 'month' : mode[0],
        mode[1] === 'date' ? 'month' : mode[1],
      ],
    });
  }

  render() {
    const { value, mode } = this.state;
    return (
      <RangePicker
        placeholder={['Start month', 'End month']}
        format="YYYY-MM"
        value={value}
        mode={mode}
        onPanelChange={this.handlePanelChange}
      />
    );
  }
}

ReactDOM.render(
  <div>
    <ControlledDatePicker />
    <br />
    <ControlledRangePicker />
  </div>
, mountNode);

API#

There are four kinds of picker:

  • DatePicker

  • MonthPicker

  • RangePicker

  • WeekPicker

Note: Part of locale of DatePicker, MonthPicker, RangePicker, WeekPicker is read from value. So, please set the locale of moment correctly.

// The default locale is en-US, if you want to use other locale, just set locale in entry file globaly.
// import moment from 'moment';
// import 'moment/locale/zh-cn';
// moment.locale('zh-cn');

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

Common API#

The following APIs are shared by DatePicker, MonthPicker, RangePicker, WeekPicker.

PropertyDescriptionTypeDefault
allowClearWhether to show clear buttonbooleantrue
autoFocusget focus when component mountedbooleanfalse
classNamepicker 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-
getCalendarContainerto set the container of the floating layer, while the default is to create a div element in bodyfunction(trigger)-
localelocalization configurationobjectdefault
openopen state of pickerboolean-
placeholderplaceholder of date inputstring|RangePicker[]-
popupStyleto customize the style of the popup calendarobject{}
sizedetermine the size of the input box, the height of large and small, are 40px and 24px respectively, while default size is 32pxstring-
styleto customize the style of the input boxobject{}
onOpenChangea callback function, can be executed whether the popup calendar is popped up or closedfunction(status)-

Common Methods#

NameDescription
blur()remove focus
focus()get focus

DatePicker#

PropertyDescriptionTypeDefault
defaultValueto set default datemoment-
disabledTimeto specify the time that cannot be selectedfunction(date)-
formatto set the date format, refer to moment.jsstring"YYYY-MM-DD"
renderExtraFooterrender extra footer in panel() => React.ReactNode-
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-
onCalendarChangea callback function, can be executed when the start time or the end time of the range is changingfunction(dates: moment, moment, dateStrings: string, string)
onChangea callback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-
onOkcallback when click ok buttonfunction()-

MonthPicker#

PropertyDescriptionTypeDefault
defaultValueto set default datemoment-
formatto set the date format, refer to moment.jsstring"YYYY-MM"
monthCellContentRenderCustom month cell content render methodfunction(date, locale): ReactNode-
renderExtraFooterrender extra footer in panel() => React.ReactNode-
valueto set datemoment-
onChangea callback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

WeekPicker#

PropertyDescriptionTypeDefault
defaultValueto set default datemoment-
formatto set the date format, refer to moment.jsstring"YYYY-Wo"
valueto set datemoment-
onChangea callback function, can be executed when the selected time is changingfunction(date: moment, dateString: string)-

RangePicker#

PropertyDescriptionTypeDefault
defaultValueto set default date[moment, moment]-
disabledTimeto specify the time that cannot be selectedfunction(dates: moment, moment, partial: 'start'|'end')-
formatto set the date formatstring"YYYY-MM-DD HH:mm:ss"
rangespreseted ranges for quick selection{ range: string: moment[] }-
renderExtraFooterrender extra footer in panel() => React.ReactNode-
showTimeto provide an additional time selectionobject|booleanTimePicker Options
showTime.defaultValueto set default time of selected date, demomoment[]moment(), moment()
valueto set date[moment, moment]-
onChangea callback function, can be executed when the selected time is changingfunction(dates: moment, moment, dateStrings: string, string)-
onOkcallback when click ok buttonfunction()-