ant-design/components/date-picker/index.en-US.md

category	type	title
Components	Data Entry	DatePicker

To select or input a date.

When To Use

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

API

There are three kinds of picker:

• DatePicker
• MonthPicker
• RangePicker

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

import moment from 'moment';

// It's recommended to set locale in entry file globaly.
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.

Property	Description	Type	Default
allowClear	Whether to show clear button	boolean	true
disabled	determine whether the DatePicker is disabled	boolean	false
style	to customize the style of the input box	object	{}
popupStyle	to customize the style of the popup calendar	object	{}
size	determine the size of the input box, the height of large and small, are 32px and 22px respectively, while default size is 28px	string	-
locale	localization configuration	object	default
disabledDate	specify the date that cannot be selected	(currentDate: moment) => boolean	-
getCalendarContainer	to set the container of the floating layer, while the default is to create a div element in body	function(trigger)	-
open	open state of picker	boolean	-
onOpenChange	a callback function, can be executed whether the popup calendar is popped up or closed	function(status)	-
placeholder	placeholder of date input	string|RangePicker[]	-

DatePicker

Property	Description	Type	Default
value	to set date	moment	-
defaultValue	to set default date	moment	-
format	to set the date format, refer to moment.js	string	"YYYY-MM-DD"
onChange	a callback function, can be executed when the selected time is changing	function(date: moment, dateString: string)	-
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
disabledTime	to specify the time that cannot be selected	function(date)	-
onOk	callback when click ok button	function()	-
renderExtraFooter	render extra footer in panel	() => React.ReactNode	-

MonthPicker

Property	Description	Type	Default
value	to set date	moment	-
defaultValue	to set default date	moment	-
format	to set the date format, refer to moment.js	string	"YYYY-MM"
onChange	a callback function, can be executed when the selected time is changing	function(date: moment, dateString: string)	-
monthCellContentRender	Custom month cell content render method	function(date, locale): ReactNode	-

RangePicker

Property	Description	Type	Default
value	to set date	[moment, moment]	-
defaultValue	to set default date	[moment, moment]	-
format	to set the date format	string	"YYYY-MM-DD HH:mm:ss"
onChange	a callback function, can be executed when the selected time is changing	function(dates: [moment, moment], dateStrings: [string, 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()]
disabledTime	to specify the time that cannot be selected	function(dates: [moment, moment], partial: `'start'	'end'`)
ranges	preseted ranges for quick selection	{ [range: string]: moment[] }	-
renderExtraFooter	render extra footer in panel	() => React.ReactNode	-
onOk	callback when click ok button	function()	-