React Date Range Input Component API

The aria-label of the day section.

The accessible name of the end field, used when it has no floating label.

The aria-label of the hour section.

The aria-label of the meridiem section.

The aria-label of the minute section.

The aria-label of the month section.

The aria-label of the quarter section.

The aria-label of the second section.

The accessible name of the start field, used when it has no floating label.

The aria-label of the week section.

The aria-label of the year section.

Focus the first section of the start date right after mounting.

A string of all className you want applied to the component.

Replaces the DD the day section shows while it is empty.

The initial end date for the uncontrolled mode. Ignored when endDate is set.

The initial start date for the uncontrolled mode. Ignored when startDate is set.

Toggle the disabled state for the component.

Specify the list of dates that cannot be selected. It can be a single Date, an [start, end] range, a matcher function, or an array of these.

The controlled end date. Pair it with onEndDateChange; for the uncontrolled mode use defaultEndDate instead.

The floating label of the end field. The text is also that field's accessible name.

Name of the value input carrying the end date. Without it the end date is not submitted with the form.

Feedback for the current validationState — rendered only while the state is set, and styled after it. For the client-side mode, where the browser owns the state, use feedbackValid and feedbackInvalid instead.

Feedback the stylesheet reveals while the control is invalid — always rendered, so it works with client-side validation, where the browser decides the state.

Feedback the stylesheet reveals while the control is valid — always rendered, so it works with client-side validation, where the browser decides the state.

A string of all className you want applied to the floating label wrapper.

Provide a floating label for the component — the text rests inside the field and floats once it has focus or a value.

Keeps the floating label floated and the placeholder visible while the field is empty.

The mask layout. A string is parsed as dayjs/moment or date-fns/luxon format tokens, a function receives the locale and returns the section layout, and undefined derives the layout from the locale.

Replaces the HH (hh on a 12-hour clock) the hour section shows while it is empty.

Custom function to parse text pasted into the field into a Date object, e.g. with an external date library.

Add a caption for a component.

Sets the default locale for the component. If not set, it is inherited from the browser.

Max selectable date.

Replaces the AM the meridiem section shows while it is empty.

Min selectable date.

Replaces the mm the minute section shows while it is empty.

Twelve custom month names for text month sections (MMM/MMMM), overriding the locale-derived, date-context grammatical form.

Replaces the MM the month section shows while it is empty.

Callback fired when the end date changes; receives the Date, or null while that end is incomplete or invalid.

Callback fired when the start date changes; receives the Date, or null while that end is incomplete or invalid.

Callback fired with undefined when the user changes either end, or the form is reset, while validationState is set. A given state is a verdict on the range it was given for; clear it here to let the browser's own validation show again.

Replaces the Q the quarter section shows while it is empty.

Toggle the readonly state for the component.

When present, it specifies that the field must be filled out before submitting the form.

Replaces the ss the second section shows while it is empty.

Include a seconds section in the locale-derived time layout.

The node rendered between the two fields. It is hidden from assistive technology.

Size the component small or large - both ends follow.

The controlled start date. Pair it with onStartDateChange; for the uncontrolled mode use defaultStartDate instead.

The floating label of the start field. The text is also that field's accessible name.

Name of the value input carrying the start date. Without it the start date is not submitted with the form.

Add helper text to the component.

Display validation feedback in a styled tooltip.

Which sections the locale-derived layout carries on both ends. A format names the sections itself and overrides this.

The validation state, rendered as the is-{state} class on the frame; 'invalid' also sets aria-invalid on the sections of both ends and blocks the submit. An end before the start and an end the limits reject mark the frame invalid on their own. The user's next change of either end asks to drop it through onValidationStateChange.

Replaces the WW the week section shows while it is empty.

Replaces the YYYY the year section shows while it is empty.