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

docs(ComboBox, DropDownMenu, SidePage, TokenInput): add examples with featureFlags, creevey #3474

Merged
merged 5 commits into from
Aug 14, 2024

Conversation

EgorovArtem34
Copy link
Member

Проблема

Подготовка для новой документации. Добавление примеров в storybook и в .md с использованием фиче-флагов

Решение

  • ComboBox добавил скриншотные тесты с фиче-флагом comboBoxAllowValueChangeInEditingState.
  • DropDownMenu добавил в .md пример с фиче-флагом menuItemsAtAnyLevel
  • SidePage добавил в SidePageWithScrollableContent проп withContent, чтобы в новой документации можно было включить фиче-флаг sidePageEnableFocusLockWhenBackgroundBlocked на этом примере
  • TokenInput переместил пример EmptyCombined первым, чтобы в новой документации на этом примере смотреть действие фиче-флага

Ссылки

YouTrack

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

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

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

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

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

@EgorovArtem34 EgorovArtem34 requested a review from SchwJ July 25, 2024 09:41
setValue({ value: `Обновленное значение`, label: `Обновленное значение` });
};

const getItems = () =>
Copy link
Member

Choose a reason for hiding this comment

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

Давай попробуем упростить пример. Например, getItems можно упростить: сделать пустым и вообще заинлайнить, так как он в тесте никак не задействован. Можно посмотреть, как выглядят существующие истории ComboBox'а

@SchwJ
Copy link
Member

SchwJ commented Aug 14, 2024

👍
Нужно сделать merge с next и можно вливать

@SchwJ SchwJ merged commit 8affe11 into next Aug 14, 2024
7 checks passed
@SchwJ SchwJ deleted the docs-tokeninput-combobox-dropdownmenu branch August 14, 2024 11:31
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