DateInput
Компонент для поля даты и времени. Позволяет пользователю вводить дату как вручную, так и выбирать значение через календарь.
Применение компонента
Данный компонент представляет собой поле формы с возможностью вызова календаря.
Если вам нужно поле ввода диапазона дат (со всплывающим календарём), то используйте компонент DateRangeInput.
Если вам нужен отдельный компонент календаря для выбора даты и времени, то используйте Calendar.
Режим работы
Компонент поддерживает работу как в неконтролируемом режиме, так и контролируемом. Это стандартное поведение React-компонентов, прочитать про это можно в документации React ↗.
Для использования неконтролируемого режима достаточно просто не передавать value или передавать defaultValue, если
требуется задать значение по умолчанию.
Для контролируемого режима используйте связку свойств value/onChange для задания значения и его изменения.
// Неконтролируемое состояние
<DateInput defaultValue={new Date()} accessible />;
// Контролируемое состояние
const [date, setDate] = React.useState(new Date());
<DateInput value={date} onChange={setDate} accessible />;Состояния
disabled
Свойство disabled блокирует взаимодействие с компонентом и добавляет визуальную индикацию недоступности.
Валидация
Свойство status используется для визуализации валидации компонента - некорректности заполненного поля (значение "error")
или успешной валидации (значение "valid").
Тестирование (e2e)
Для тестирования компонента можно использовать следующие свойство определяющие data-testid атрибуты:
dayFieldTestId— поле ввода дня;monthFieldTestId— поле ввода месяца;yearFieldTestId— поле ввода года;hourFieldTestId— поле ввода часа;minuteFieldTestId— поле ввода минут.
Подробности смотри в Свойства и методы.
Доступность (a11y)
Компонент обеспечивает базовую доступность, но по умолчанию компонент всё ещё сложно использовать пользователям ассистивных технологий. Мы доработали компонент так, чтобы сделать его доступным, но это потребовало ломающих изменений в визуальном поведении компонента.
Новое, доступное поведение можно включить с помощью нового свойства accessible.
Вот список изменений которые отличают поведение со свойством accessible от поведения по умолчанию:
- иконка календаря видна постоянно (раньше она была видна, только если в
DateInputнет значения); - календарь открывается только по клику по иконке календаря, по клику на поле ввода и нажатию клавиши
<Space>, еслиDateInputв фокусе (раньше он открывался сразу при фокусе наDateInput); - при открытии календарь получает фокус. При закрытии календаря фокус возвращается на
DateInput. Если нужно отключить это поведение, используйте свойствоdisableFocusTrap. Если нужно больше контроля над тем, куда возвращать фокус, используйте свойствоrestoreFocus.
Из-за особенности реализации DateInput, если вкладывать его внутрь label, или связывать label и DateInput через htmlFor,
то по клику на label фокус будет попадать на DateInput, но текст label скринридером зачитываться в момент фокуса не будет.
Рекомендуем дублировать текст label в DateInput, передавая в DateInput текст через свойство aria-label.
<label>
День рождения
<DateInput aria-label="День рождения" accessible />
</label><label htmlFor="date"> День рождения</label>
<DateInput id="date" aria-label="День рождения" accessible /><FormItem top="День рождения" htmlFor="date">
<DateInput id="date" aria-label="День рождения" accessible />
</FormItem>Интернационализация (i18n)
Формат дат и их перевод задаётся с помощью средств браузера Intl.DateTimeFormat ↗. Тем не менее компонент, в том числе и календарь, имеют большое количество внутренних интерактивных элементов, которые должны иметь описание. Особенно важно для доступности (a11y), так как большинство подписей зрячему пользователю не видны, но критически важны пользователям скринридеров.
Ниже приведён список свойств, которые стоит использовать, если требуется перевести компонент на другой язык. Полный список ищите в таблице свойств компонента ниже.
changeHoursLabel;changeMinutsLabel;changeDayLabel;changeMonthLabel;changeYearLabel;prevMonthLabel;nextMonthLabel;clearFieldLabel;showCalendarLabel;calendarLabel.
Свойства и методы
| Свойство | Описание |
|---|---|
accessible | booleanВключает режим в котором DateInput доступен для ассистивных технологий. В этом режиме:
По умолчанию: - |
after | ReactNodeДобавляет иконку справа. Рекомендации:
По умолчанию: - |
afterAlign | FieldIconsAlignВертикальное выравнивание иконки справа. По умолчанию: - |
before | ReactNodeДобавляет иконку слева. Рекомендации:
По умолчанию: - |
beforeAlign | FieldIconsAlignВертикальное выравнивание иконки слева. По умолчанию: - |
calendarLabel | string
По умолчанию: Календарь |
calendarPlacement | PlacementWithAutoРасположение календаря относительно поля ввода. По умолчанию: bottom-start |
calendarTestsProps | CalendarTestsPropsПередает атрибуты По умолчанию: - |
changeDayLabel | string
По умолчанию: День |
changeHoursLabel | stringТекст выпадающего списка с выбором часов. Делает его доступным для ассистивных технологий. По умолчанию: Час |
changeMinutesLabel | stringТекст выпадающего списка с выбором минут. Делает его доступным для ассистивных технологий. По умолчанию: Минута |
changeMonthLabel | string
По умолчанию: Месяц |
changeYearLabel | string
По умолчанию: Год |
clearButtonTestId | stringПередает атрибут По умолчанию: - |
clearFieldLabel | stringLabel для кнопки очистки. Делает доступным для ассистивных технологий. По умолчанию: Очистить поле |
closeOnChange | booleanАвтоматически закрывать календарь при изменениях. По умолчанию: true |
dayFieldTestId | stringПередает атрибут По умолчанию: - |
defaultValue | Date | nullНачальная дата при монтировании. По умолчанию: - |
disableCalendar | booleanОтключение открытия календаря. По умолчанию: false |
disableFocusTrap | booleanПозволяет отключить захват фокуса при появлении календаря. По умолчанию: - |
disableFuture | booleanЗапрещает выбор даты в будущем.
Применяется, если не задано По умолчанию: - |
disablePast | booleanЗапрещает выбор даты в прошлом.
Применяется, если не заданы По умолчанию: - |
disablePickers | booleanОтключает селекторы выбора месяца/года. По умолчанию: - |
DoneButton | ComponentType<ButtonProps>Кастомное отображение кнопки По умолчанию: - |
doneButtonText | stringТекст отображаемый в кнопке По умолчанию: - |
enableTime | booleanВключает выбор времени. По умолчанию: - |
getRootRef | Ref<HTMLDivElement>По умолчанию: - |
hourFieldTestId | stringПередает атрибут По умолчанию: - |
maxDateTime | DateМаксимальные дата и время, которые можно выбрать.
Применяется, если не заданы По умолчанию: - |
minDateTime | DateМинимальные дата и время, которые можно выбрать.
Применяется, если не заданы По умолчанию: - |
minuteFieldTestId | stringПередает атрибут По умолчанию: - |
mode | "default" | "plain"Режим отображения.
По умолчанию: - |
monthFieldTestId | stringПередает атрибут По умолчанию: - |
nextMonthIcon | ReactNodeКастомная иконка для кнопки следующего месяца. По умолчанию: - |
nextMonthLabel | string
По умолчанию: Следующий месяц |
onApply | ((value?: Date) => void) | undefinedОбработчик нажатия на кнопку По умолчанию: - |
onCalendarOpenChanged | ((opened: boolean) => void)Обработчик изменения состояния открытия календаря. По умолчанию: - |
onChange | ((value?: Date) => void) | undefinedОбработчик изменения выбранной даты. По умолчанию: - |
onHeaderChange | ((value: Date) => void)Обработчик изменения даты в шапке календаря. По умолчанию: - |
onNextMonth | (() => void)Нажатие на кнопку переключения на следующий месяц. По умолчанию: - |
onPrevMonth | (() => void)Нажатие на кнопку переключения на предыдущий месяц. По умолчанию: - |
prevMonthIcon | ReactNodeКастомная иконка для кнопки предыдущего месяца. По умолчанию: - |
prevMonthLabel | string
По умолчанию: Предыдущий месяц |
renderCustomValue | ((date: Date) => ReactNode) | undefinedФункция для кастомного форматирования отображаемого значения даты. Позволяет переопределить стандартное отображение даты и вернуть собственное представление. По умолчанию: - |
renderDayContent | ((day: Date) => ReactNode)Кастомизация отображения содержимого дня. По умолчанию: - |
restoreFocus | boolean | (() => boolean | HTMLElement)По умолчанию: true |
shouldDisableDate | ((value: Date) => boolean)Функция для проверки запрета выбора даты. По умолчанию: - |
showCalendarButtonTestId | stringПередает атрибут По умолчанию: - |
showCalendarLabel | stringLabel для кнопки открытия календаря. Делает доступным для ассистивных технологий. По умолчанию: Показать календарь |
showNeighboringMonth | booleanПоказывать дни соседних месяцев. По умолчанию: - |
size | "s" | "m"Размер календаря. По умолчанию: - |
status | "default" | "error" | "valid"Статус отображения поля в форме. По умолчанию: - |
timezone | stringЧасовой пояс для отображения даты. По умолчанию: - |
value | Date | nullТекущая выбранная дата. По умолчанию: - |
viewDate | DateДата отображаемого месяца. При использовании обновление даты должно происходить вне компонента. По умолчанию: - |
weekStartsOn | 0 | 1 | 2 | 3 | 4 | 5 | 6День недели, с которого начинается неделя. По умолчанию: - |
yearFieldTestId | stringПередает атрибут По умолчанию: - |