Skip to content

Instantly share code, notes, and snippets.

@b2whats
Last active February 27, 2019 09:40
Show Gist options
  • Save b2whats/f77778bf69574d3c137d3661cd09c9b5 to your computer and use it in GitHub Desktop.
Save b2whats/f77778bf69574d3c137d3661cd09c9b5 to your computer and use it in GitHub Desktop.
requirements

Наименование компонента

Минимальное описание или графческое представление

Обсуждение

Тут бубут находится все обсуждения этого компонента в виде форализованных сообщений, ссылки на возможный дизайн и примеры

Когда использовать

Описание случаев использования

Требования и дизайн

Требования к дизайну и интерфейсу компонента оформленные в виде текста или изображения, тут должны быть финальные согласования

Наименование составных частей

Требования к каждой части

Описание работы

Формальное описание компонента учитывающее все кейсы использования в основном нужно для разработчика

Возможный интерфейс

Описание возможного интерфейса для согласования с заказчиком

interface OptionItem<Option> {
    index: number,
    option: Option,
    optionText: string,
    disabled?: boolean,
    search: string,
    selected: boolean,
}

Suggest

Prop Type Required Default Description
children React$Node false Контент
minimal boolean false Минимальная длина
...rest any false ...

Примеры использования

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

Описание доступности компонента

aria accessibility

Другие соображения

  • Использование children кажется достойным способом избежать того, что в противном случае было бы созданием множества состояний в интерфейсе
    • Содержимое заголовка зависит от порядка, поэтому реквизиты типа start, center, end может иметь больше смысла, чем children. Также рассмотрим подход slot: <Header> <SomeComponent slot ="start"/> </ Header>.
  • Вместо того, чтобы задержать релиз, разработав Search, AppSwitcher, Notifications, и профиль в первую очередь, HeaderContainer будет просто применять нужный текст и принимать любых детей, тем самым позволяя заказчикам использовать все, что им нужно.
    • Не уверен, где эти компоненты должны находиться. Как вариант, HeaderSearch, HeaderAppSwitcher и т.д ...?
  • HeaderWorkspacePicker может быть более подходящим, чем просто WorkSpacePicker
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment