DateRangeInput

Компонент для поля выбора диапазона дат, позволяет пользователю выбрать начальную и конечную дату как через ручной ввод, так и через календарь.

Загружается...

Данный компонент представляет собой поле формы с возможностью вызова календаря.

Если вам нужен отдельный компонент календаря для выбора диапазона дат, то используйте CalendarRange.

Если вам нужно поле ввода одиночной даты и времени (со всплывающим календарём), то используйте DateInput.

Компонент поддерживает работу как в неконтролируемом режиме, так и контролируемом. Это стандартное поведение React-компонентов, прочитать про это можно в документации React ↗.

Для использования неконтролируемого режима достаточно просто не передавать value или передавать defaultValue, если требуется задать значение по умолчанию. Для контролируемого режима используйте связку свойств value/onChange для задания значения и его изменения.

// Неконтролируемое состояние
<DateRangeInput defaultValue={[new Date(2024, 2, 1), new Date(2024, 2, 10)]} accessible />;
 
// Контролируемое состояние
const [date, setDate] = React.useState([new Date(2024, 2, 1), new Date(2024, 2, 10)]);
 
<DateRangeInput value={date} onChange={setDate} accessible />;

Свойство disabled блокирует взаимодействие с компонентом и добавляет визуальную индикацию недоступности.

Загружается...

Свойство status используется для визуализации валидации компонента - некорректности заполненного поля (значение "error") или успешной валидации (значение "valid").

Загружается...

Для тестирования компонента можно использовать следующие свойство определяющие data-testid атрибуты:

  • calendarTestsProps
  • startDateTestsProps
  • endDateTestsProps
  • showCalendarButtonTestId
  • clearButtonTestId

Подробности смотри в Свойства и методы.

Компонент обеспечивает базовую доступность, но по умолчанию компонент всё ещё сложно использовать пользователям ассистивных технологий. Мы доработали компонент так, чтобы сделать его доступным, но это потребовало ломающих изменений в визуальном поведении компонента.

Новое, доступное поведение можно включить с помощью нового свойства accessible.

Вот список изменений которые отличают поведение со свойством accessible от поведения по умолчанию:

  • иконка календаря видна постоянно (раньше она была видна, только если в DateRangeInput нет значения);
  • календарь открывается только по клику по иконке календаря, по клику на поле ввода и нажатию клавиши <Space>, если DateRangeInput в фокусе (раньше он открывался сразу при фокусе на DateRangeInput);
  • при открытии календарь получает фокус. При закрытии календаря фокус возвращается на DateRangeInput. Если нужно отключить это поведение, используйте свойство disableFocusTrap. Если нужно больше контроля над тем, куда возвращать фокус, используйте свойство restoreFocus.

Из-за особенности реализации DateRangeInput, если вкладывать его внутрь label, или связывать label и DateRangeInput через htmlFor, то по клику на label фокус будет попадать на DateRangeInput, но текст label скринридером зачитываться в момент фокуса не будет. Рекомендуем дублировать текст label в DateRangeInput, передавая в DateRangeInput текст через свойство aria-label.

<label>
  Период проживания
  <DateRangeInput aria-label="Период проживания" accessible />
</label>
<label htmlFor="date">Срок действия договора</label>
<DateRangeInput
  id="date"
  aria-label="Срок действия договора"
  accessible
/>
<FormItem top="Период бронирования" htmlFor="date">
  <DateRangeInput id="date" aria-label="Период бронирования" accessible />
</FormItem>

Формат дат и их перевод задаётся с помощью средств браузера Intl.DateTimeFormat ↗. Тем не менее компонент, в том числе и календарь, имеют большое количество внутренних интерактивных элементов, которые должны иметь описание. Особенно важно для доступности (a11y), так как большинство подписей зрячему пользователю не видны, но критически важны пользователям скринридеров.

Ниже приведён список свойств, которые стоит использовать, если требуется перевести компонент на другой язык. Полный список ищите в таблице свойств компонента ниже.

  • changeDayLabel;
  • changeMonthLabel;
  • changeYearLabel;
  • changeStartDayLabel;
  • changeStartMonthLabel;
  • changeStartYearLabel;
  • changeEndDayLabel;
  • changeEndMonthLabel;
  • changeEndYearLabel;
  • prevMonthLabel;
  • nextMonthLabel;
  • clearFieldLabel;
  • showCalendarLabel;
  • calendarLabel.
СвойствоОписание
accessibleboolean

Включает режим в котором DateRangeInput доступен для ассистивных технологий. В этом режиме:

  • календарь больше не открывает при фокусе на DateRangeInput;
  • иконка календаря видна всегда, чтобы пользователи ассистивных технологий могли открыть календарь по клику на иконку;
  • календарь при открытии получает фокус, клавиатурный фокус зациклен и не выходит за пределы календаря пока календарь не закрыт.
По умолчанию: -
afterReactNode

Добавляет иконку справа.

Рекомендации:

  • Используйте следующие размеры иконок 12 | 16 | 20 | 24 | 28.
  • Используйте IconButton ↗, если вам нужна иконка, реагируюущая на нажатие.
По умолчанию: -
afterAlignFieldIconsAlign

Вертикальное выравнивание иконки справа.

По умолчанию: -
beforeReactNode

Добавляет иконку слева.

Рекомендации:

  • Используйте следующие размеры иконок 12 | 16 | 20 | 24 | 28.
  • Используйте IconButton ↗, если вам нужна иконка, реагирующая на нажатие.
По умолчанию: -
beforeAlignFieldIconsAlign

Вертикальное выравнивание иконки слева.

По умолчанию: -
calendarLabelstring

Label для календаря.

По умолчанию: Календарь
calendarPlacementPlacementWithAuto

Расположение календаря относительно поля ввода.

По умолчанию: bottom-start
calendarTestsPropsCalendarRangeTestsProps

Передает атрибуты data-testid для интерактивных элементов в календаре.

По умолчанию: -
changeDayLabelstring

Deprecated: Since 7.4.0.

Будет удалeно в VKUI v8. Использовалось для задания aria-label для контейнера дней в календаре. Теперь этот контейнер является таблицей (с помощью role=“grid”) и в aria-label рендерится текущий открытый в календаре месяц и год.

По умолчанию: -
changeEndDayLabelstring

Label для ввода дня конечной даты. Делает доступным для ассистивных технологий.

По умолчанию: День окончания
changeEndMonthLabelstring

Label для ввода месяца конечной даты. Делает доступным для ассистивных технологий.

По умолчанию: Месяц окончания
changeEndYearLabelstring

Label для ввода года конечной даты. Делает доступным для ассистивных технологий.

По умолчанию: Год окончания
changeMonthLabelstring

aria-label для селектора месяца.

По умолчанию: Месяц
changeStartDayLabelstring

Label для ввода дня начальной даты. Делает доступным для ассистивных технологий.

По умолчанию: День начала
changeStartMonthLabelstring

Label для ввода месяца начальной даты. Делает доступным для ассистивных технологий.

По умолчанию: Месяц начала
changeStartYearLabelstring

Label для ввода года начальной даты. Делает доступным для ассистивных технологий.

По умолчанию: Год начала
changeYearLabelstring

aria-label для селектора года.

По умолчанию: Год
clearButtonTestIdstring

Передает атрибут data-testid для кнопки очистки даты.

По умолчанию: -
clearFieldLabelstring

Label для кнопки очистки. Делает доступным для ассистивных технологий.

По умолчанию: Очистить поле
closeOnChangeboolean

Автоматически закрывать календарь при изменениях.

По умолчанию: true
defaultValueDateRangeType | null

Начальный промежуток при монтировании.

По умолчанию: -
disableCalendarboolean

Отключение открытия календаря.

По умолчанию: false
disableFocusTrapboolean

Позволяет отключить захват фокуса при появлении календаря.

По умолчанию: -
disableFutureboolean

Запрещает выбор даты в будущем. Применяется, если не задано shouldDisableDate.

По умолчанию: -
disablePastboolean

Запрещает выбор даты в прошлом. Применяется, если не заданы shouldDisableDate и disableFuture.

По умолчанию: -
disablePickersboolean

Отключает селекторы выбора месяца/года.

По умолчанию: -
endDateTestsPropsDateTestsProps

Передает атрибуты data-testid для полей ввода конечной даты.

По умолчанию: -
getRootRefRef<HTMLDivElement>
По умолчанию: -
mode"default" | "plain"

Режим отображения.

  • default — показывает фон, обводку и, при наличии, текст-подсказку.
  • plain — показывает только текст-подсказку.
По умолчанию: -
nextMonthIconReactNode

Кастомная иконка для кнопки следующего месяца.

По умолчанию: -
nextMonthLabelstring

aria-label для кнопки следующего месяца.

По умолчанию: Следующий месяц
onCalendarOpenChanged((opened: boolean) => void)

Обработчик изменения состояния открытия календаря.

По умолчанию: -
onChange((value: DateRangeType) => void) | undefined

Обработчик изменения выбранного промежутка.

По умолчанию: -
prevMonthIconReactNode

Кастомная иконка для кнопки предыдущего месяца.

По умолчанию: -
prevMonthLabelstring

aria-label для кнопки предыдущего месяца.

По умолчанию: Предыдущий месяц
renderDayContent((day: Date) => ReactNode)

Кастомизация отображения содержимого дня.

По умолчанию: -
restoreFocusboolean | (() => boolean | HTMLElement)
По умолчанию: true
shouldDisableDate((value: Date) => boolean)

Функция для проверки запрета выбора даты.

По умолчанию: -
showCalendarButtonTestIdstring

Передает атрибут data-testid для кнопки показа календаря.

По умолчанию: -
showCalendarLabelstring

Label для кнопки открытия календаря. Делает доступным для ассистивных технологий.

По умолчанию: Показать календарь
startDateTestsPropsDateTestsProps

Передает атрибуты data-testid для полей ввода начальной даты.

По умолчанию: -
status"default" | "error" | "valid"

Статус отображения поля в форме.

По умолчанию: -
valueDateRangeType | null

Текущий выбранный промежуток.

По умолчанию: -
weekStartsOn0 | 1 | 2 | 3 | 4 | 5 | 6

День недели, с которого начинается неделя.

По умолчанию: -