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 a panel.

Multiple

Multiple selections. Does not support showTime and picker="time".

Switchable picker

Switch in different types of pickers by Select.

Choose Time

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

Limit Date Range

Limit the range of available dates by using minDate and maxDate.

Disabled Date & Time

Disable specific dates and times by using disabledDate and disabledTime respectively, and disabledTime only works with showTime.

Select range dates

Using info.from of disabledDate to limit the dynamic date range selection.

Extra Footer

Render extra footer in panel for customized requirements.

Customized Cell Rendering

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

External use panel

Custom menu, external selection panel.

Status

Add status to DatePicker with status, which could be error or warning.

Custom semantic dom styling

You can customize the semantic dom style of DatePicker by passing objects/functions through classNames and styles.

Prefix and Suffix

Custom prefix and suffixIcon.

Range Picker

Set range picker type by picker prop.

Need Confirm

DatePicker will automatically determine whether to show a confirm button according to the picker property. You can also set the needConfirm property to determine whether to show a confirm button. When needConfirm is set, the user must click the confirm button to complete the selection. Otherwise, the selection will be submitted when the picker loses focus or selects a date.

Date Format

We can set the date format by format. When format is an array, the input box can be entered in any of the valid formats of the array.

Mask Format

Align the date format. Switch the selection by arrow keys. Will try to align the date to the last valid date when blur.

Disabled

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

Allow Empty

Allow empty for the RangePicker. It's useful when you need to keep the "to date".

Preset Ranges

We can set preset ranges to RangePicker to improve user experience. Since 5.8.0, preset value supports callback function.

Three Sizes

The input box comes in three sizes: small, medium and large. The medium size will be used if size is omitted.

Customize Panel

Replace panel with components.

Buddhist Era

Use locale to support special calendar format.

Variants

Variants of DatePicker, there are four variants: outlined filled borderless and underlined.

Placement

You can manually specify the position of the popup via placement.

API

DatePicker, DatePicker.RangePicker, and the picker panels are exported from @ceebee/ui/client.

Common API

Property	Description	Type	Default	Version
`allowClear`	Customize clear button	`boolean \| { clearIcon?: ReactNode }`	`true`	5.8.0: Support object type
`bordered`	Whether has border style, please use variant instead	`boolean`	`true`	-
`className`	The picker className	`string`	`-`	—
`classNames`	Customize class for each semantic structure inside the component. Supports object or function.	`Record<SemanticDOM, string> \| (info: { props })=> Record<SemanticDOM, string>`	`-`	—
`dateRender`	Custom rendering function for date cells, >= 5.4.0 use cellRender instead.	`function(currentDate: dayjs, today: dayjs) => React.ReactNode`	`-`	< 5.4.0
`cellRender`	Custom rendering function for picker cells	`(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`	Custom panels	`Record<Panel \| 'input', React.ComponentType>`	`-`	5.14.0
`defaultOpen`	Initial open state of picker	`boolean`	`-`	—
`disabled`	Determine whether the DatePicker is disabled	`boolean`	`false`	—
`disabledDate`	Specify the date that cannot be selected	`(currentDate: dayjs, info: { from?: dayjs, type: Picker }) => boolean`	`-`	info: 5.14.0
`dropdownClassName`	The className of popup calendar, please use classNames.popup.root instead	`string`	`-`	-
`format`	To set the date format, support multi-format matching when it is an array, display the first one shall prevail. refer to dayjs#format. for example: Custom Format	`formatType`	`@rc-component/picker`	—
`order`	Auto order date when multiple or range selection	`boolean`	`true`	5.14.0
`popupClassName`	To customize the className of the popup calendar, use classNames.popup.root instead	`string`	`-`	4.23.0
`preserveInvalidOnBlur`	Don't clear the input on blur even when the typed value is invalid	`boolean`	`false`	5.14.0
`getPopupContainer`	To set the container of the floating layer, while the default is to create a div element in body	`function(trigger)`	`-`	—
`inputReadOnly`	Set the readonly attribute of the input tag (avoids virtual keyboard on touch devices)	`boolean`	`false`	—
`locale`	Localization configuration	`object`	`default`	—
`minDate`	The minimum date, which also limits the range of panel switching	`dayjs`	`-`	5.14.0
`maxDate`	The maximum date, which also limits the range of panel switching	`dayjs`	`-`	5.14.0
`mode`	The picker panel mode ( Cannot select year or month anymore? )	`time \| date \| month \| year \| decade`	`-`	—
`needConfirm`	Need click confirm button to trigger value change. Default false when multiple	`boolean`	`-`	5.14.0
`nextIcon`	The custom next icon	`ReactNode`	`-`	4.17.0
`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]`	`-`	—
`placement`	The position where the selection box pops up	`bottomLeft bottomRight topLeft topRight`	`bottomLeft`	—
`popupStyle`	To customize the style of the popup calendar, use styles.popup.root instead	`CSSProperties`	`{}`	—
`prefix`	The custom prefix	`ReactNode`	`-`	5.22.0
`presets`	The preset ranges for quick selection, Since 5.8.0, preset value supports callback function.	`{ label: React.ReactNode, value: Dayjs \| (() => Dayjs) }\[]`	`-`	—
`prevIcon`	The custom prev icon	`ReactNode`	`-`	4.17.0
`previewValue`	When the user selects the date hover option, the value of the input field undergoes a temporary change	`false \| hover`	`hover`	6.0.0
`size`	To determine the size of the input box, the height of large and small, are 40px and 24px respectively, while default size is 32px	`large \| medium \| small`	`-`	—
`status`	Set validation status	`'error' \| 'warning'`	`-`	4.19.0
`style`	To customize the style of the input box	`CSSProperties`	`{}`	—
`styles`	Customize inline style for each semantic structure inside the component. Supports object or function.	`Record<SemanticDOM, CSSProperties> \| (info: { props })=> Record<SemanticDOM, CSSProperties>`	`-`	—
`suffixIcon`	The custom suffix icon	`ReactNode`	`-`	—
`superNextIcon`	The custom super next icon	`ReactNode`	`-`	4.17.0
`superPrevIcon`	The custom super prev icon	`ReactNode`	`-`	4.17.0
`clearIcon`	(Only supports global configuration) Custom clear icon	`ReactNode`	`-`	×
`variant`	Variants of picker	`outlined \| borderless \| filled \| underlined`	`outlined`	5.13.0 \| underlined: 5.24.0
`onClear`	Callback when click the clear button	`() => void`	`-`	6.5.0
`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)`	`-`	—
`onSelect`	Callback when a date is selected, please use onCalendarChange instead	`function(value)`	`-`	-

DatePicker

Property	Description	Type	Default	Version
`defaultPickerValue`	Default panel date, will be reset when panel open	`dayjs`	`-`	5.14.0
`defaultValue`	To set default date, if start time or end time is null or undefined, the date range will be an open interval	`dayjs`	`-`	—
`disabledTime`	To specify the time that cannot be selected	`function(date)`	`-`	—
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY-MM-DD`	—
`multiple`	Enable multiple selection. Not support showTime	`boolean`	`false`	5.14.0
`pickerValue`	Panel date. Used for controlled switching of panel date. Work with onPanelChange	`dayjs`	`-`	5.14.0
`renderExtraFooter`	Render extra footer in panel	`(mode) => React.ReactNode`	`-`	—
`showNow`	Show the fast access of current datetime	`boolean`	`-`	4.4.0
`showTime`	To provide an additional time selection	`object \| boolean`	`TimePicker Options`	—
`showTime.defaultValue`	Use showTime.defaultOpenValue instead	`dayjs`	`dayjs()`	5.27.3
`showTime.defaultOpenValue`	To set default time of selected date, demo	`dayjs`	`dayjs()`	—
`showWeek`	Show week info when in DatePicker	`boolean`	`false`	5.14.0
`value`	To set date	`dayjs`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(date: dayjs \| null, dateString: string \| null)`	`-`	—
`onOk`	Callback when click ok button	`function()`	`-`	—
`onPanelChange`	Callback function for panel changing	`function(value, mode)`	`-`	—

DatePicker\[picker=year]

Property	Description	Type	Default	Version
`defaultValue`	To set default date	`dayjs`	`-`	—
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY`	—
`multiple`	Enable multiple selection	`boolean`	`false`	5.14.0
`renderExtraFooter`	Render extra footer in panel	`() => React.ReactNode`	`-`	—
`tagRender`	Customize tag render, only applies when multiple is set	`(props) => ReactNode`	`-`	6.4.0
`value`	To set date	`dayjs`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(date: dayjs \| null, dateString: string \| null)`	`-`	—

DatePicker\[picker=quarter]

Property	Description	Type	Default	Version
`defaultValue`	To set default date	`dayjs`	`-`	—
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY-\QQ`	—
`multiple`	Enable multiple selection	`boolean`	`false`	5.14.0
`renderExtraFooter`	Render extra footer in panel	`() => React.ReactNode`	`-`	—
`tagRender`	Customize tag render, only applies when multiple is set	`(props) => ReactNode`	`-`	6.4.0
`value`	To set date	`dayjs`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(date: dayjs \| null, dateString: string \| null)`	`-`	—

DatePicker\[picker=month]

Property	Description	Type	Default	Version
`defaultValue`	To set default date	`dayjs`	`-`	—
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY-MM`	—
`multiple`	Enable multiple selection	`boolean`	`false`	5.14.0
`renderExtraFooter`	Render extra footer in panel	`() => React.ReactNode`	`-`	—
`tagRender`	Customize tag render, only applies when multiple is set	`(props) => ReactNode`	`-`	6.4.0
`value`	To set date	`dayjs`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(date: dayjs \| null, dateString: string \| null)`	`-`	—

DatePicker\[picker=week]

Property	Description	Type	Default	Version
`defaultValue`	To set default date	`dayjs`	`-`	—
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY-wo`	—
`multiple`	Enable multiple selection	`boolean`	`false`	5.14.0
`renderExtraFooter`	Render extra footer in panel	`(mode) => React.ReactNode`	`-`	—
`tagRender`	Customize tag render, only applies when multiple is set	`(props) => ReactNode`	`-`	6.4.0
`value`	To set date	`dayjs`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(date: dayjs \| null, dateString: string \| null)`	`-`	—
`showWeek`	Show week info when in DatePicker	`boolean`	`true`	5.14.0

RangePicker

Property	Description	Type	Default	Version
`allowEmpty`	Allow start or end input leave empty	`\[boolean, boolean]`	`\[false, false]`	—
`cellRender`	Custom rendering function for picker cells	`(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`	Custom rendering function for date cells, >= 5.4.0 use cellRender instead.	`function(currentDate: dayjs, today: dayjs) => React.ReactNode`	`-`	< 5.4.0
`defaultPickerValue`	Default panel date, will be reset when panel open	`\[dayjs, dayjs]`	`-`	5.14.0
`defaultValue`	To set default date	`\[dayjs, dayjs]`	`-`	—
`disabled`	If disable start or end	`\[boolean, boolean]`	`-`	—
`disabledTime`	To specify the time that cannot be selected	`function(date: dayjs, partial: start \| end, info: { from?: dayjs })`	`-`	info.from: 5.17.0
`format`	To set the date format. refer to dayjs#format	`formatType`	`YYYY-MM-DD HH:mm:ss`	—
`id`	Config input ids	`{ start?: string, end?: string }`	`-`	5.14.0
`pickerValue`	Panel date. Used for controlled switching of panel date. Work with onPanelChange	`\[dayjs, dayjs]`	`-`	5.14.0
`presets`	The preset ranges for quick selection, Since 5.8.0, preset value supports callback function.	`{ label: React.ReactNode, value: \[(Dayjs \| (() => Dayjs)), (Dayjs \| (() => Dayjs))] }\[]`	`-`	—
`renderExtraFooter`	Render extra footer in panel	`() => React.ReactNode`	`-`	—
`separator`	Set separator between inputs	`React.ReactNode`	`<SwapRightOutlined />`	—
`showTime`	To provide an additional time selection	`object \| boolean`	`TimePicker Options`	—
`showTime.defaultValue`	Use showTime.defaultOpenValue instead	`\[dayjs, dayjs]`	`\[dayjs(), dayjs()]`	5.27.3
`showTime.defaultOpenValue`	To set default time of selected date, demo	`\[dayjs, dayjs]`	`\[dayjs(), dayjs()]`	—
`value`	To set date	`\[dayjs, dayjs]`	`-`	—
`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: \[dayjs, dayjs], dateStrings: \[string, string], info: { range:start\|end })`	`-`	—
`onChange`	Callback function, can be executed when the selected time is changing	`function(dates: \[dayjs, dayjs] \| null, dateStrings: \[string, string] \| null)`	`-`	—
`onFocus`	Trigger when get focus	`function(event, { range: 'start' \| 'end' })`	`-`	range: 5.14.0
`onBlur`	Trigger when lose focus	`function(event, { range: 'start' \| 'end' })`	`-`	range: 5.14.0