Skip to content

feat(): Add new <DateRangePicker> component #3586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 121 commits into from
Apr 13, 2025
Merged

feat(): Add new <DateRangePicker> component #3586

merged 121 commits into from
Apr 13, 2025

Conversation

sashachabin
Copy link
Member

@sashachabin sashachabin commented Jan 16, 2025

<DateRangePicker>

Привет! Сделал компонент для выбора периода <DateRangePicker>

image

Документация

  • Компонент состоит из двух <DateInput> и одного общего <Calendar> с диапазоном:
    • <DateRangePicker.Start /> — начало периода, настройки как у <DateInput>
    • <DateRangePicker.End /> — конец периода, настройки как у <DateInput>
    • <DateRangePicker.Separator /> — разделитель
  • В календаре диапазон рисуется через <Calendar renderDay={...} />. Проп renderDay так же доступен для настройки в DateRangePicker. Например, можно собрать календарь с ценами
  • Опциональные периоды. Добавлены кнопки «Без первой даты», «Без второй даты»
  • Поддержка всех пропо <DatePicker />. Например, enableTodayLink, useMobileNativeDatePicker , onMonthChange
  • По аналогии с DatePicker добавлен метод для валидации DatePickerRange.validate(startValue, endValue, {options}). В отдельном PR пример работы с библиотекой валидаций
  • Тёмная тема
  • Мобильная версия
  • Доступность. По умолчанию настроены aria-group и aria-label для полей и правки в DateInput
  • Локали. Наследуются значения DatePicker с добавлением нескольких новых (опциональные периоды и доступность)

Предыдущее API для работы со значениями (устарело после обсуждений)

Работа со значениями

Важная особенность компонента — он не только состоит из нескольких частей, но и в нём сразу 2 input. В процессе разработки выработал 2 принципа:

  1. Все значения задаются парами (так сделано в самых популярных библиотеках — ant.design и mui):
    • Период задается в формате value={['dd.mm.yyyy', 'dd.mm.yyyy']} (формат настраивается)
    • Пропы optional, warning, error задаются в формате [true, false]
  2. Внутри children подразумевается только кастомизация оберток и <DateInput> без работы со значениями

Ссылки

IF-87 — там ссылки на дизайн, референсы и фидбек от разных команд

Чек-лист перед запросом ревью

  1. Добавлены тесты на все изменения
    ✅ unit-тесты для логики
    ✅ скриншоты для верстки и кросс-браузерности
    ⬜ нерелевантно

  2. Добавлена (обновлена) документация
    ✅ styleguidist для пропов и примеров использования компонентов
    ✅ jsdoc для утилит и хелперов
    ✅ комментарии для неочевидных мест в коде
    ✅ прочие инструкции (README.md, contributing.md и др.)
    ⬜ нерелевантно

  3. Изменения корректно типизированы
    ✅ без использования any (см. PR 2856)
    ⬜ нерелевантно

  4. Прочее
    ✅ все тесты и линтеры на CI проходят
    ✅ в коде нет лишних изменений**
    ✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)

@sashachabin sashachabin requested a review from zhzz January 16, 2025 07:28
@sashachabin

This comment was marked as outdated.

@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from a8b895b to 23df406 Compare January 16, 2025 08:35
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from 23df406 to 52fab02 Compare February 7, 2025 06:50
@sashachabin sashachabin changed the base branch from next to date-range-picker February 7, 2025 06:54
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch 4 times, most recently from 8a6fbaf to aa9ffd5 Compare February 24, 2025 17:28
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from 2a24d34 to df140b9 Compare February 26, 2025 10:46
@sashachabin sashachabin changed the base branch from date-range-picker to next February 26, 2025 12:05
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch 2 times, most recently from 393cca9 to bd1cc39 Compare February 27, 2025 05:55
Copy link
Member

@zhzz zhzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Пока посмотрел только часть, без тестов и мобильного вида.

По поведению заметил такую особенность. Если maxDate меньше выбранной даты в инпуте, то при фокусе на нем Календарь покажет месяц, отличный от того, что выбран. И может быть сложно доскролить до выбранной даты, если она далеко, т.к. выпадашки месяца и года отключены.

Оригинальный DatePicker в этом плане отличается, показывая выбранный месяц.

Так и задумано? Не успел еще со всей аналитикой ознакомиться.


@sashachabin: всё так, это ошибка — поправил!

@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from 6950e53 to f3a399c Compare March 5, 2025 03:53
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from f3a399c to 96e4794 Compare March 7, 2025 05:01
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch 5 times, most recently from 73e8461 to d6aab5d Compare March 14, 2025 10:21
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch 4 times, most recently from 519972f to c954047 Compare April 4, 2025 12:12
@sashachabin sashachabin force-pushed the date-range-picker-5.x branch from fb05e10 to b52215a Compare April 8, 2025 03:03
@zhzz zhzz merged commit fcf697a into next Apr 13, 2025
0 of 6 checks passed
@zhzz zhzz deleted the date-range-picker-5.x branch April 13, 2025 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants