02Дизайн-системы
Документация компонента
Документация по компоненту: API, варианты, состояния, доступность, использование.
Напиши документацию для компонента {{component}}.
Структура
{{component}}
[1-2 предложения: что делает и когда использовать]
Когда использовать
- ✓ Сценарий 1
- ✓ Сценарий 2
- ✗ НЕ использовать в сценарии 3 (используй [другой компонент])
API
| Prop | Тип | Default | Описание |
|---|---|---|---|
| variant | "primary" | "secondary" | "ghost" | "primary" | Визуальный вариант |
| size | "sm" | "md" | "lg" | "md" | Размер |
| disabled | boolean | false | Заблокирован |
| ... |
Варианты
[Скриншот / код для каждого варианта]
Состояния
- Default
- Hover
- Active
- Focus (видимый!)
- Disabled
- Loading (если применимо)
Доступность
- Семантический HTML (
<button>, не<div>) - ARIA: что обязательно, что опционально
- Клавиатура: Enter / Space / Esc
- Фокус-индикатор: что появляется
- Screen reader: что слышит пользователь
Использование
<Button variant="primary" onClick={...}>
Сохранить
</Button>
Не используй так
<!-- Плохо: длинный текст -->
<Button>Нажмите здесь чтобы сохранить ваши изменения...</Button>
<!-- Плохо: иконка без accessible name -->
<Button><Icon /></Button>
Похожие компоненты
- Link — когда нужна навигация
- IconButton — только иконка
Изменения
- v1.2: добавили loading state
- v1.1: добавили variant="ghost"
Принципы
- API минимальный. Если можно без prop'а — не делай
- Примеры — реальные, не "Foo Bar"
- "Не используй так" — обязательная секция
- Доступность не в конце — это базовое требование
Похожие промты
site / audit
Аудит brand-consistency
Прогон интерфейса на согласованность: цвета, spacing, typography, voice, иконки. Найти отклонения от системы.
auditdesign-systembrand
Открыть
Средний30-60 мин
site / audit
Brand guidelines с нуля
Сборка полного гайдлайна: voice, color tokens, типографика, правила логотипа, антипаттерны и примеры. Готовый DESIGN.md.
brandguidelinesdesign-system
Открыть
Продвинутый2-4 часа
design / ui
Сгенерировать варианты UI-компонента
Создать 4-6 разных подходов к компоненту с разным визуальным языком и трейд-оффами.
uicomponentsvariants
Открыть
Начальный15-30 мин