Date Range Picker

The selected date range.

A function that is called when the selected date changes.

Whether or not the value is controlled or not. If true, the component will not update the value state internally, instead it will call onValueChange when it would have otherwise, and it is up to you to update the value prop that is passed to the component.

The placeholder date, which is used to determine what date to start the segments from when no value exists.

A function that is called when the placeholder date changes.

Whether or not the placeholder is controlled or not. If true, the component will not update the placeholder state internally, instead it will call onPlaceholderChange when it would have otherwise, and it is up to you to update the value prop that is passed to the component.

An array of segments that should be readonly, which prevent user input on them.

A function that returns whether or not a date is unavailable.

The minimum valid date that can be entered.

The maximum valid date that can be entered.

A function that returns whether or not a date is unavailable.

A callback fired when the date field's value is invalid.

The granularity to use for formatting the field. Defaults to 'day' if a CalendarDate is provided, otherwise defaults to 'minute'. The field will render segments for each part of the date up to and including the specified granularity.

Whether or not to hide the time zone segment of the field.

The id of the element which contains the error messages for the date field when the date is invalid.

The hour cycle to use for formatting times. Defaults to the locale preference

The locale to use for formatting dates.

Whether or not the accordion is disabled.

Whether or not the field is readonly.

Whether or not the date field is required.

Whether or not to close the popover when a date range is selected.

Whether or not to disable days outside the current month.

Whether or not to use paged navigation for the calendar. Paged navigation causes the previous and next buttons to navigate by the number of months displayed at once, rather than by one month.

Whether or not to prevent the user from deselecting a date without selecting another date first.

The format to use for the weekday strings provided via the weekdays slot prop.

The day of the week to start the calendar on. 0 is Sunday, 1 is Monday, etc.

The accessible label for the calendar.

Whether or not to always display 6 weeks in the calendar.

A function that returns whether or not a date is disabled.

The number of months to display at once.

The open state of the popover content.

A callback that fires when the open state changes.

Whether or not the open state is controlled or not. If true, the component will not update the open state internally, instead it will call onOpenChange when it would have otherwise, and it is up to you to update the open prop that is passed to the component.

A function that is called when the end date changes.

A function that is called when the start date changes.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the root element when the calendar is invalid.

Present on the root element when the calendar is disabled.

Present on the root element when the calendar is readonly.

Present on the root element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the element when the field is invalid

Present on the element.

The name of the input field used for form submission. If provided a hidden input will be rendered alongside the field.

The type of field to render (start or end).

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the element when the field is invalid.

Present on the element when the field is disabled.

Present on the element.

The part of the date to render.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the element when the field is invalid

Present on the element when the field is disabled

The type of segment the element represents.

Present on the element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Whether the popover is open or closed.

Present on the trigger element.

The preferred side of the anchor to render the floating element against when open. Will be reversed when collisions occur.

The distance in pixels from the anchor to the floating element.

The preferred alignment of the anchor to render the floating element against when open. This may change when collisions occur.

The distance in pixels from the anchor to the floating element.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

When true, overrides the side and align options to prevent collisions with the boundary edges.

A boundary element or array of elements to check for collisions against.

The amount in pixels of virtual padding around the viewport edges to check for overflow which will cause a collision.

The sticky behavior on the align axis. 'partial' will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst 'always' will keep the content in the boundary regardless.

When true, hides the content when it is detached from the DOM. This is useful for when you want to hide the content when the user scrolls away.

The strategy to use when updating the position of the content. When 'optimized' the content will only be repositioned when the trigger is in the viewport. When 'always' the content will be repositioned whenever the position changes.

The positioning strategy to use for the floating element. When 'fixed' the element will be positioned relative to the viewport. When 'absolute' the element will be positioned relative to the nearest positioned ancestor.

When true, prevents the body from scrolling when the content is open. This is useful when you want to use the content as a modal.

Use an element other than the trigger to anchor the content to. If provided, the content will be anchored to the provided element instead of the trigger.

Callback fired when an outside interaction event completes, which is either a pointerup, mouseup, or touchend event, depending on the user's input device. You can call event.preventDefault() to prevent the default behavior of handling the outside interaction.

Callback fired when focus leaves the dismissible layer. You can call event.preventDefault() to prevent the default behavior on focus leaving the layer.

The behavior to use when an interaction occurs outside of the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Callback fired when an escape keydown event occurs in the floating content. You can call event.preventDefault() to prevent the default behavior of handling the escape keydown event.

The behavior to use when an escape keydown event occurs in the floating content. 'close' will close the content immediately. 'ignore' will prevent the content from closing. 'defer-otherwise-close' will defer to the parent element if it exists, otherwise it will close the content. 'defer-otherwise-ignore' will defer to the parent element if it exists, otherwise it will ignore the interaction.

Event handler called when auto-focusing the content as it is opened. Can be prevented.

Event handler called when auto-focusing the content as it is closed. Can be prevented.

Whether or not to trap the focus within the content when open.

When true, prevents the text selection from overflowing the bounds of the element.

Whether or not to forcefully mount the content. This is useful if you want to use Svelte transitions or another animation library for the content.

The reading direction of the app.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Whether the popover is open or closed.

Present on the content element.

Present on the root element when the calendar is invalid.

Present on the root element when the calendar is disabled.

Present on the root element when the calendar is readonly.

Present on the root element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the header element when the calendar is disabled.

Present on the header element when the calendar is readonly.

Present on the header element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the prev button element when the calendar or this button is disabled.

Present on the prev button element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the heading element when the calendar is disabled.

Present on the heading element when the calendar is readonly.

Present on the heading element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the next button element when the calendar or this button is disabled.

Present on the next button element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the grid element when the calendar is disabled.

Present on the grid element when the calendar is readonly.

Present on the grid element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the grid row element when the calendar is disabled.

Present on the grid row element when the calendar is readonly.

Present on the grid row element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the grid head element when the calendar is disabled.

Present on the grid head element when the calendar is readonly.

Present on the grid head element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the head cell element when the calendar is disabled.

Present on the head cell element when the calendar is readonly.

Present on the head cell element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present on the grid element when the calendar is disabled.

Present on the grid element when the calendar is readonly.

Present on the grid body element.

The date for the cell.

The current month the date is being displayed in.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present when the day is disabled.

Present when the day is unavailable.

Present when the day is today.

Present when the day is outside the current month.

Present when the day is outside the visible months.

Present when the day is focused.

Present when the day is selected.

The date in the format "YYYY-MM-DD".

Present on the cell element.

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

The children content to render.

Use render delegation to render your own element. See Child Snippet docs for more information.

Present when the day is disabled.

Present when the day is unavailable.

Present when the day is today.

Present when the day is outside the current month.

Present when the day is outside the visible months.

Present when the day is focused.

Present when the day is selected.

The date in the format "YYYY-MM-DD".

Present on the day element.