-
Notifications
You must be signed in to change notification settings - Fork 127
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
HelenaIsh
wants to merge
37
commits into
next
Choose a base branch
from
multiline-combobox
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Проблема
Когда в комбобоксе есть длинные пункты меню - их неудобно редактировать
screen.recording.2023-09-19.12.14.14.mov
Решение
Добавила проп
viewMode
, который имеет три состояния:'singleLine'
- дефолтное состояние в одну строку'multiline'
- комбобокс расширяется по содержимому (всегда)'multilineEditing'
- комбобокс расширяется по содержимому (только при редактировании)Обсуждали также четвертый вариант, когда комбобокс не раздвигает контент, а располагается над контентом. В итоге мы не нашли запроса на такой сценарий, а также его достаточно легко реализовать на стороне пользователя - смотри последний пример в документации комбобокса.
API
Было еще два варианта реализации API:
<РасширяемыйCombobox />
В итоге не взяла в работу, так как многострочный комбобокс по логике работы никак не должен отличаться от обычного однострочного, поэтому не хочется путать пользователя выбором между разными компонентами
as
илиelement
илиrender
Не взяла в работу так как в комбобоксе два режима: режим отображения и режим редактирования. Элементы для каждого из них отличаются, поэтому нужно было бы вводить два пропа, что неудобно пользователю.
Техническая реализация
В комбобоксе есть два режима: отображение и редактирование.
В режиме отображения рендерится внутренний компонент
InputLikeText
. Для того чтобы он стал расширяемым добавила boolean пропisMultiline
, который добавляет необходимые стили, позволяющие отображать содержимое в несколько строк.В режиме редактирования рендерится компонент
Input
, который уже нельзя научить расширяться. Хотелось бы использовать компонентTextarea
, но у него нет пропов для левой и правой иконок. Добавление иконок напрямую вTextarea
было бы ломающим изменением, так как сейчас вся логика работает на нативной<textarea />
, добавление обертки и перенос логики на нее ломает тесты. Поэтому для многострочного комбобокса создала внутренний компонентInternalTextareaWithLayout
, который по сути являетсяTextarea
c использованием лэйаута для иконок изInput
.Дополнительно:
Textarea
добавила необходимыеaria
атрибуты и пропalign
для полной совместимости с комбобоксом.- нашла небольшую проблему с высотой в `Textarea`:
В некоторых случаях высота выставляется неверно. Например, можно посмотреть однострочную Teaxtarea в разных браузерах. Разница небольшая - пара пикселей, но в комбобоксе при переключении с
InputLikeText
наInternalTextareaWithLayout
это заметно. Проблема в том, что при расчете высоты (getTextAreaHeight
) она устанавливается на нативнуюtextarea
, но обертки вокруг могут добавить лишний пиксель. Решила не решать проблему глобально, а исправить только для конкретного случая.Ссылки
IF-595
Чек-лист перед запросом ревью
Добавлены тесты на все изменения
✅ unit-тесты для логики
✅ скриншоты для верстки и кросс-браузерности
⬜ нерелевантно
Добавлена (обновлена) документация
✅ styleguidist для пропов и примеров использования компонентов
⬜ jsdoc для утилит и хелперов
⬜ комментарии для неочевидных мест в коде
⬜ прочие инструкции (
README.md
,contributing.md
и др.)⬜ нерелевантно
Изменения корректно типизированы
✅ без использования
any
(см. PR2856
)⬜ нерелевантно
Прочее
✅ все тесты и линтеры на CI проходят
✅ в коде нет лишних изменений
✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)