Fields component
The field components let the user input date and time values with a keyboard and refined keyboard navigation.
Introduction
The fields are React components that let you enter a date or time with the keyboard, without using any popover or modal UI. They provide refined navigation through arrow keys and support advanced behaviors like localization and validation.
Fields to edit a single element
DateField
TimeField
DateTimeField
Fields to edit a range
All fields to edit a range are available in a single input version and in a multi input version.
MultiInputDateRangeField
โ
SingleInputDateRangeField
MultiInputTimeRangeField
โ
SingleInputTimeRangeField
MultiInputDateTimeRangeField
โ
SingleInputDateTimeRangeField
Advanced
What is a section?
In the field components, the date is divided into several sections, each one responsible for the edition of a date token.
For example, if the format passed to the field is MM/DD/YYYY
, the field will create 3 sections:
- A
month
section for the tokenMM
- A
day
section for the tokenDD
- A
year
section for the tokenYYYY
Those sections are independent, pressing ArrowUp while focusing the day
section will add one day to the date, but it will never change the month or the year.
Control the selected sections
Use the selectedSections
and onSelectedSectionsChange
props to control which sections are currently being selected.
This prop accepts the following formats:
- If a number is provided, the section at this index will be selected.
- If
"all"
is provided, all the sections will be selected. - If an object with a
startIndex
andendIndex
fields are provided, the sections between those two indexes will be selected. - If a string of type
FieldSectionType
is provided, the first section with that name will be selected. - If
null
is provided, no section will be selected
Usage with multi input range fields
For multi input range fields, you just have to make sure that the right input is focused before updating the selected section(s). Otherwise, the section(s) might be selected on the wrong input.
start
end
โ
Usage with single input range fields
For single input range fields, you won't be able to use the section name to select a single section because each section is present both in the start and in the end date.
Instead, you can pass the index of the section using the unstableFieldRef
prop to access the full list of sections:
start
end