Документация · библиотека 1.1.1
Документация
Карта разделов и три маршрута: запустить сегодня, разобраться в устройстве, найти конкретный ответ.
С чего начать
Быстрый старт
Пять шагов от пустой директории до цветной кнопки на экране. Всё, что глубже, — на соседних страницах.
- 1Быстрый старт5 мин
- 2Установка8 мин
- 3Конфигурация6 мин
Установите пакет и его обязательные peer-зависимости
npm i @feugene/granularity @feugene/granum @floating-ui/dom vuepnpm add @feugene/granularity @feugene/granum @floating-ui/dom vueyarn add @feugene/granularity @feugene/granum @floating-ui/dom vuebun add @feugene/granularity @feugene/granum @floating-ui/dom vueНачало работы4
От пустого каталога до работающего компонента.
- ВведениеЧто такое Granularity и какое одно решение задаёт в ней всё остальное.
- Быстрый стартПять шагов от пустой директории до цветной кнопки на экране. Всё, что глубже, — на соседних страницах.
- УстановкаЧто ставится, почему именно это и куда — dependencies или devDependencies. Плюс иконки и опциональные интеграции.
- КонфигурацияДефолты на поддерево через GrConfigProvider, порядок их разрешения, авто-импорт и runtime-адаптер.
Устройство4
Как устроена библиотека: темы, доступность, языки, вес.
- ТемизацияРоли, а не хексы: как сменить бренд, не тронув ни одного компонента, и почему тему собирают, а не пишут руками.
- ДоступностьКлавиатурный контракт, стек оверлеев, живой регион и правила контраста — что библиотека гарантирует и чем это держится.
- ЛокализацияБиблиотека не заводит свой i18n-стек: локаль, словари и хранение выбора остаются за приложением. Три языка в поставке.
- ПроизводительностьГранулярность — главное обещание продукта. Страница показывает, чем оно измеряется и как проверить его самому.
Интеграции4
Встраивание в ваш стек: типы, серверный рендер, тесты, Storybook.
- TypeScriptТипы приезжают вместе с подпутём: props, emits, инстанс и токены. Плюс web-types для JetBrains, о котором мало кто знает.
- SSRПакет безопасен для серверного рендера целиком. Оговорки касаются не безопасности, а того, что именно приходит с сервера.
- ТестированиеПомощники для тестов приложения, границы jsdom и правила, без которых тест зеленеет на сломанном коде.
- StorybookСвоего Storybook у библиотеки нет и не будет. Как подключить компоненты в ваш — конфиг, тема, оверлеи и главная ловушка.
Обновления и помощь3
Сколько живёт версия, переезды между мажорами, типовые поломки.
- ВерсионированиеЧто обещает 1.x, как пакеты семейства связаны версиями и чего библиотека пока не обещает.
- МиграцияПереезды между мажорами: что сломал переход с 0.x на 1.0 и как его пройти.
- Типовые поломкиСимптом, причина, починка. Собрано по тем случаям, которые ломались на самом деле, а не по воображаемым.
Здесь ничего не нашлось. Попробуйте поиск по всему сайту — ⌘K.
Найти ответ
- Какие клавиши у компонента, что с фокусом и скринридеромДоступность →
- Работает ли это на сервере и что придёт с сервераSSR →
- Как подключить переводы и на скольких языках говорит библиотекаЛокализация →
- Откуда берутся типы и почему их не видит компиляторTypeScript →
- Чем тестировать и что в jsdom не проверяетсяТестирование →
- Сколько проживёт линия 1.x и что считается ломающим изменениемВерсионирование →
В других разделах сайта
Компоненты116 компонентов из 8 пакетов: у каждого песочница, примеры и таблица API.Компоненты →ОсновыТокены, цветовые роли, шкала шрифта и остальной визуальный язык.Основы →Справочник APIComposables, директивы и утилиты вне компонентов.Справочник API →ИзмененияЧто менялось от версии к версии.v1.1.1 →