Wrap with the Filter Provider to apply the selected time range to child components.

Props API

disableDateUntilNow
boolean
If set to true, disables the option within the picker that allows users to select a range extending to the current date.
disableCustomRange
boolean
If set to true, disables the option for users to select a custom date range.
disableCustomRelative
boolean
If set to true, disables the option for selecting relative date ranges, such as “last n days.”
disableOptions
boolean
If set to true, disables all selectable options in the component, effectively making it read-only.
disabled
boolean
If true, the entire component is disabled, and users cannot interact with it.
defaultValue
DateRangeOptionsProps
Sets an initial default value for the picker using a structured object that defines a range of options.
value
DateRangeOptionsProps
Controls the current value of the picker through a structured object, enabling controlled component behavior.
locale
string
The locale used to format the date and time values, e.g. “en-US”.
options
(defaultOptions: DateRangeOptionsProps[]) => DateRangeOptionsProps[] | undefined
A function that allows for customizing the list of quick selection options based on default options provided.
onChange
(option: DateRangeOptionsProps) => void
A callback function that is fired when the selected value changes, providing the new value as an argument.
defaultOpen
boolean
If true, the select is open by default.