Date Range Picker

Preview

Install

Add it with the shadcn CLI, or copy the source manually.

$ bunx --bun shadcn add @beui/date-range-picker

API Reference

DateRangePicker

value?
DateRange | null
Default—
defaultValue?
DateRange | null
Default—
onValueChange?
((range: DateRange | null) => void)
Default—
defaultMonth?
string
Default—
min?
string
Default—
max?
string
Default—
isDateDisabled?
((date: string) => boolean)
Default—
presets?
DateRangePreset[]
Default—
locale?
string
Default—
label?
string
Default—
disabled?
boolean
Default—
autoFocus?
boolean

Move focus to the active date on mount, for use inside a popover.

Default—
showSummary?
boolean

Show the start/end summary above the calendar. Default true.

Default—
className?
string
Default—
children?
ReactNode

Compose custom controls; omitted children render the inline calendar.

Default—
open?
boolean
Default—
defaultOpen?
boolean
Default—
onOpenChange?
((open: boolean) => void)
Default—
closeOnSelect?
boolean

Close an open popover after a complete range or preset. Default false.

Default—
labels?
Partial<{ label: string; placeholder: string; triggerLabel: string; selectEnd: string; startDate: string; endDate: string; selectDate: string; chooseMonth: string; chooseYear: string; previousMonth: string; ... 18 more ...; presetSelected: string; }>

Override any built-in string.

Default—

DateRangePickerCalendar

showSummary?
boolean
Default—
className?
string
Default—

DateRangePickerSummary

className?
string
Default—

DateRangePickerHeader

className?
string
Default—

DateRangePickerGrid

className?
string
Default—

DateRangePickerSelection

className?
string
Default—

DateRangePickerClear

className?
string
Default—

DateRangePickerFooter

className?
string
Default—

DateRangePickerPresets

className?
string
Default—

DateRangePickerPreset

value
DateRange
Default—
label
string

Accessible preset name and selection announcement.

Default—
className?
string
Default—

DateRangePickerTrigger

placeholder?
string
Default—
className?
string
Default—

DateRangePickerContent

autoFocus?
boolean

Move focus to the active calendar date when opened. Default true.

Defaulttrue
side?
"top" | "bottom"
Default—
align?
"end" | "start"
Default—
sideOffset?
number

Gap between trigger and panel, in px. Default 8.

Default—
radius?
number

Panel corner radius, in px. Default 16.

Default—
shadow?
boolean

Draw the surface shadow. Default true.

Default—
onOpenAutoFocus?
((content: HTMLDivElement) => void)

Runs after the portalled surface is positioned and visible. Passing it hands focus to the caller: the panel then moves no focus on its own.

Default—
initialFocus?
RefObject<HTMLElement | null>

Element to focus when the trigger opens the panel by keyboard. Defaults to the first focusable element in the panel, or the panel itself. A pointer open does not move focus. Ignored with `onOpenAutoFocus`.

Default—
className?
string
Default—

DateRangePickerDropdown

placeholder?
string
Default—
triggerClassName?
string
Default—
calendarClassName?
string
Default—
label?
string
Default—
defaultValue?
DateRange | null
Default—
autoFocus?
boolean

Move focus to the active date on mount, for use inside a popover.

Defaulttrue
className?
string
Default—
labels?
Partial<{ label: string; placeholder: string; triggerLabel: string; selectEnd: string; startDate: string; endDate: string; selectDate: string; chooseMonth: string; chooseYear: string; previousMonth: string; ... 18 more ...; presetSelected: string; }>

Override any built-in string.

Default—
locale?
string
Default—
value?
DateRange | null
Default—
min?
string
Default—
max?
string
Default—
disabled?
boolean
Default—
onValueChange?
((range: DateRange | null) => void)
Default—
open?
boolean
Default—
closeOnSelect?
boolean

Close an open popover after a complete range or preset. Default false.

Default—
defaultMonth?
string
Default—
isDateDisabled?
((date: string) => boolean)
Default—
presets?
DateRangePreset[]
Default—
showSummary?
boolean

Show the start/end summary above the calendar. Default true.

Defaultfalse
defaultOpen?
boolean
Default—
onOpenChange?
((open: boolean) => void)
Default—

Updated