DatePicker #

DatePicker is a highly customizable component that allows users to enter and pick dates and times in different formats.

Usage #

Examples #

Basic #

Customize the date format #

Size #

One tap #

Appearance #

Block #

Placeholder #

ISO week #

International Standard ISO 8601 defines that each calendar week begins on Monday and Sunday is the seventh day, ISO week date.

The calendar panel can be displayed in ISO standard via the isoWeek property setting.

Week start #

The calendar panel can be displayed in different week start days via the weekStart property setting.

Show week numbers #

Disabled and read only #

Loading state #

With a label #

Disable input #

DatePicker allows date and time input via keyboard by default, if you wish to disable it, you can disable input by setting editable={false}.

Set the local language #

DatePicker supports local language custom configuration, but we recommend using the unified i18n configuration.

Placement #

Tip: When set to auto*, try to scroll the page, or change the browser size, it will automatically appear in the right place.

Custom short options #

Clicking "Prev Day" in the example does not close the picker layer because the closeOverlay=false property is configured. This property is used to set whether to close the picker layer after clicking the shortcut item. The default value is true.

Controlled vs. uncontrolled value #

Selection range #

Custom Calendar Icon #

Custom Calendar Cell #

Custom render value #

Native pickers #

If you only need to meet the simple date selection function, you can use the native pickers supported by the browser.

Accessibility #

ARIA properties #

Has all ARIA properties of the DateInput component by default.

• The aria-invalid="true" attribute is added to the <input> element when the value is invalid.
• When label is set, the aria-labelledby attribute is added to the <input> element and the dialog element and is set to the value of the id attribute of label.
• Has the aria-haspopup="dialog" attribute to indicate that the component has an interactive dialog.

Keyboard interactions #

Has keyboard interaction for the DateInput component by default.

• When the focus is on the calendar, use the → ← ↓ ↑ keys to switch dates.
• When the focus is on the calendar, use the Enter key to select a date.
• When the DatePicker component has editable={false} set to disable input, use ↓ to move focus to the calendar.

Props #

<DatePicker> #

Property	Type(default)	Description
appearance	'default' | 'subtle' ('default')	Set picker appearence
block	boolean	Blocking an entire row
calendarDefaultDate	Date	Calendar panel default presentation date and time
caretAs	ElementType	Custom component for the caret icon
cleanable	boolean (true)	Whether the selected value can be cleared
container	HTMLElement | (() => HTMLElement)	Sets the rendering container
defaultOpen	boolean	Default value of open property
defaultValue	Date	Default value
disabled	boolean	Whether disabled the component
disabledDate	(date:Date) => boolean	⚠️[Deprecated] Use shouldDisableDate instead
disabledHours	(hour:number, date:Date) => boolean	⚠️[Deprecated] Use shouldDisableHour instead
disabledMinutes	(minute:number, date:Date) => boolean	⚠️[Deprecated] Use shouldDisableMinute instead
disabledSeconds	(second:number, date:Date) => boolean	⚠️[Deprecated] Use shouldDisableSecond instead
editable	boolean (true)	Rendered as an input, the date can be entered via the keyboard
format	string ('yyyy-MM-dd')	Format of the date when rendered in the input
hideHours	(hour:number, date:Date) => boolean	Hidden hours
hideMinutes	(minute:number, date:Date) => boolean	Hidden minutes
hideSeconds	(second:number, date:Date) => boolean	Hidden seconds
isoWeek	boolean	ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day
label	ReactNode	A label displayed at the beginning of toggle button
limitEndYear	number (1000)	Set the upper limit of the available year relative to the current selection date
limitStartYear	number	Set the lower limit of the available year relative to the current selection date
loading	boolean (false)	Whether to display a loading state indicator
locale	CalendarLocaleType	Locale text
onChange	(date: Date) => void	Callback fired when value changed
onChangeCalendarDate	(date: Date, event) => void	Callback function that changes the calendar date.
onClean	(event) => void	Callback fired when value clean
onClose	() => void	Callback fired when close component
onEnter	() => void	Callback fired before the overlay transitions in
onEntered	() => void	Callback fired after the overlay finishes transitioning in
onEntering	() => void	Callback fired as the overlay begins to transition in
oneTap	boolean	One click to complete the selection date
onExit	() => void	Callback fired right before the overlay transitions out
onExited	() => void	Callback fired after the overlay finishes transitioning out
onExiting	() => void	Callback fired as the overlay begins to transition out
onNextMonth	(date: Date) => void	Switch to the callback function for the next Month
onOk	(date: Date, event) => void	Click the OK callback function
onOpen	() => void	Callback fired when open component
onPrevMonth	(date: Date) => void	Switch to the callback function for the previous Month
onSelect	(date: Date) => void	Callback fired when date or time is selected
onShortcutClick	(shortcut: Range, event) => void	Callback fired when shortcut clicked
onToggleMonthDropdown	(open: boolean) => void	Callback function that switches to the month view
onToggleTimeDropdown	(open: boolean) => void	Callback function that switches to the time view
open	boolean	Whether open the component
placeholder	string	Placeholder
placement	Placement ('bottomStart')	The placement of component
preventOverflow	boolean	Prevent floating element overflow
ranges	Range[] (Ranges)	Shortcut config
renderCell	(date: Date) => ReactNode	Custom calendar cell rendering
renderValue	(date: Date, format: string) => string	Custom render value
shouldDisableDate	(date:Date) => boolean	Disabled date
shouldDisableHour	(hour:number, date:Date) => boolean	Disabled hours
shouldDisableMinute	(minute:number, date:Date) => boolean	Disabled minutes
shouldDisableSecond	(second:number, date:Date) => boolean	Disabled seconds
showMeridian	boolean	Display hours in 12 format
showWeekNumbers	boolean	Whether to show week numbers
size	'lg' | 'md' | 'sm' | 'xs' ('md')	A picker can have different sizes
value	Date	Value (Controlled)
weekStart	0 | 1 | 2 | 3 | 4 | 5 | 6 (0)	The index of the first day of the week (0 - Sunday). If isoWeek is true, the value of weekStart is ignored

ts:Placement #

type Placement =
  | 'bottomStart'
  | 'bottomEnd'
  | 'topStart'
  | 'topEnd'
  | 'leftStart'
  | 'leftEnd'
  | 'rightStart'
  | 'rightEnd'
  | 'auto'
  | 'autoVerticalStart'
  | 'autoVerticalEnd'
  | 'autoHorizontalStart'
  | 'autoHorizontalEnd';

ts:Range #

interface Range {
  label: ReactNode;
  value: Date | ((date: Date) => Date);
  closeOverlay?: boolean;

  // Sets the position where the predefined range is displayed, the default is bottom.
  placement?: 'bottom' | 'left';
}

ts:Ranges #

import { addDays } from 'date-fns';

const Ranges = [
  {
    label: 'today',
    value: new Date(),
    closeOverlay: true
  },
  {
    label: 'yesterday',
    value: addDays(new Date(), -1),
    closeOverlay: true
  }
];