Date Range Field

Alpha

Allows users to input a range of dates within a designated field.

View code

Booking

yyyy

Features

Full keyboard navigation
Can be controlled or uncontrolled
Focus is fully managed
Localization support
Highly composable
Accessible by default
Supports both date and date-time formats

Preface

The component depends on the @internationalized/date package, which solves a lot of the problems that come with working with dates and times in JavaScript.

We highly recommend reading through the documentation for the package to get a solid feel for how it works, and you'll need to install it in your project to use the date-related components.

Installation

Install the date package.

$ npm add @internationalized/date

Install the component from your command line.

$ npm add reka-ui

Anatomy

Import all parts and piece them together.

vue

<script setup>
import {
  DateRangeFieldInput,
  DateRangeFieldRoot,
} from 'reka-ui'
</script>

<template>
  <DateRangeFieldRoot>
    <DateRangeFieldInput />
  </DateRangeFieldRoot>
</template>

API Reference

Root

Contains all the parts of a date field

Prop	Default	Type
`as`	`'div'`	`AsTag \| Component` The element or component this component should render as. Can be overwrite by `asChild`
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`defaultPlaceholder`		`DateValue` The default placeholder date
`defaultValue`		`DateRange` The default value for the calendar
`dir`		`'ltr' \| 'rtl'` The reading direction of the date field when applicable. If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
`disabled`	`false`	`boolean` Whether or not the date field is disabled
`granularity`		`'day' \| 'hour' \| 'minute' \| 'second'` The granularity to use for formatting times. 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
`hideTimeZone`		`boolean` Whether or not to hide the time zone segment of the field
`hourCycle`		`12 \| 24` The hour cycle used for formatting times. Defaults to the local preference
`id`		`string` Id of the element
`isDateUnavailable`		`Matcher` A function that returns whether or not a date is unavailable
`locale`		`string` The locale to use for formatting dates
`maxValue`		`DateValue` The maximum date that can be selected
`minValue`		`DateValue` The minimum date that can be selected
`modelValue`		`DateRange` The controlled checked state of the calendar. Can be bound as `v-model`.
`name`		`string` The name of the field. Submitted with its owning form as part of a name/value pair.
`placeholder`		`DateValue` The placeholder date, which is used to determine what month to display when no date is selected. This updates as the user navigates the calendar and can be used to programmatically control the calendar view
`readonly`	`false`	`boolean` Whether or not the date field is readonly
`required`		`boolean` When `true`, indicates that the user must set the value before the owning form can be submitted.

Emit	Payload
`update:modelValue`	`[DateRange]` Event handler called whenever the model value changes
`update:placeholder`	`[date: DateValue]` Event handler called whenever the placeholder value changes

Slots (default)	Payload
`modelValue`	`DateRange`
`segments`	`{ start: { part: SegmentPart; value: string; }[]; end: { part: SegmentPart; value: string; }[]; }`

Methods	Type
`isDateUnavailable`	`Matcher` A function that returns whether or not a date is unavailable
`setFocusedElement`	`(el: HTMLElement) => void`

Data Attribute	Value
`[data-readonly]`	Present when readonly
`[data-disabled]`	Present when disabled
`[data-invalid]`	Present when invalid

Input

Contains the date field segments

Prop	Default	Type
`as`	`'div'`	`AsTag \| Component` The element or component this component should render as. Can be overwrite by `asChild`
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`part*`		`'day' \| 'month' \| 'year' \| 'hour' \| 'minute' \| 'second' \| 'dayPeriod' \| 'literal' \| 'timeZoneName'` The part of the date to render
`type*`		`'start' \| 'end'` The type of field to render (start or end)

Data Attribute	Value
`[data-disabled]`	Present when disabled
`[data-invalid]`	Present when invalid
`[data-placeholder]`	Present when no value is set

Accessibility

Keyboard Interactions

Key	Description
`Tab`	When focus moves onto the date field, focuses the first segment.
`ArrowLeftArrowRight`	Navigates between the date field segments.
`ArrowUpArrowDown`	Increments/changes the value of the segment.
`0-9`	When the focus is on a numeric `DateFieldInput`, it types in the number and focuses the next segment if the next input would result in an invalid value.
`Backspace`	Deletes a digit from the focused numeric segments.
`AP`	When the focus is on the day period, it sets it to AM or PM.

Date Range Field ​

Features ​

Preface ​

Installation ​

Anatomy ​

API Reference ​

Root ​

Input ​

Accessibility ​

Keyboard Interactions ​