Skip to content
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

feat(Combobox): add multiline behavior #3364

Draft
wants to merge 37 commits into
base: next
Choose a base branch
from
Draft

Conversation

HelenaIsh
Copy link
Member

@HelenaIsh HelenaIsh commented Feb 29, 2024

Проблема

Когда в комбобоксе есть длинные пункты меню - их неудобно редактировать

screen.recording.2023-09-19.12.14.14.mov

Решение

Добавила проп viewMode, который имеет три состояния:

  1. 'singleLine' - дефолтное состояние в одну строку
  2. 'multiline' - комбобокс расширяется по содержимому (всегда)
  3. 'multilineEditing' - комбобокс расширяется по содержимому (только при редактировании)

Обсуждали также четвертый вариант, когда комбобокс не раздвигает контент, а располагается над контентом. В итоге мы не нашли запроса на такой сценарий, а также его достаточно легко реализовать на стороне пользователя - смотри последний пример в документации комбобокса.

API

Было еще два варианта реализации API:

  1. Новый компонент: <РасширяемыйCombobox />
    В итоге не взяла в работу, так как многострочный комбобокс по логике работы никак не должен отличаться от обычного однострочного, поэтому не хочется путать пользователя выбором между разными компонентами
  2. Проп as или element или render
    Не взяла в работу так как в комбобоксе два режима: режим отображения и режим редактирования. Элементы для каждого из них отличаются, поэтому нужно было бы вводить два пропа, что неудобно пользователю.

Техническая реализация

В комбобоксе есть два режима: отображение и редактирование.

В режиме отображения рендерится внутренний компонент InputLikeText. Для того чтобы он стал расширяемым добавила boolean проп isMultiline, который добавляет необходимые стили, позволяющие отображать содержимое в несколько строк.

В режиме редактирования рендерится компонент Input, который уже нельзя научить расширяться. Хотелось бы использовать компонент Textarea, но у него нет пропов для левой и правой иконок. Добавление иконок напрямую в Textarea было бы ломающим изменением, так как сейчас вся логика работает на нативной <textarea />, добавление обертки и перенос логики на нее ломает тесты. Поэтому для многострочного комбобокса создала внутренний компонент InternalTextareaWithLayout, который по сути является Textarea c использованием лэйаута для иконок из Input.

Дополнительно:

  • Для Textarea добавила необходимые aria атрибуты и проп align для полной совместимости с комбобоксом.
- нашла небольшую проблему с высотой в `Textarea`:

В некоторых случаях высота выставляется неверно. Например, можно посмотреть однострочную Teaxtarea в разных браузерах. Разница небольшая - пара пикселей, но в комбобоксе при переключении с InputLikeText на InternalTextareaWithLayout это заметно. Проблема в том, что при расчете высоты (getTextAreaHeight) она устанавливается на нативную textarea, но обертки вокруг могут добавить лишний пиксель. Решила не решать проблему глобально, а исправить только для конкретного случая.

В firefox В chrome
image image

Ссылки

IF-595

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

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

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

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

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

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.

None yet

1 participant