Дока · Установка
Установка и подключение
skob-ui — обычный Nuxt-модуль. Требования: Nuxt ≥ 3.13 (рекомендуется Nuxt 4), Tailwind 3.4+ или 4, Vue 3.5.
1. Установить пак #
Основной канал — публичный npm. В монорепо с pnpm — как обычная зависимость.
pnpm add skob-uiПока пак не опубликован: локальная установка через file: или pnpm link; git+https — запасной канал.
2. Подключить модуль #
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['skob-ui']
})Модуль сам: регистрирует компоненты (префикс Sk), подключает автоимпорт composables/utils, вколачивает токены темы, добавляет source-пути пака для Tailwind.
Опции модуля #
| Опция | По умолчанию | Что делает |
|---|---|---|
| prefix | 'Sk' | Префикс имён компонентов: SkButton, SkSelect… |
| tokens | true | Подключать tokens.css (CSS-переменные дефолтной темы). |
| theme | {} | Глобальная тема (уровень 2): переопределения словарей по компонентам. Доступна через useSkTheme(). |
export default defineNuxtConfig({
modules: ['skob-ui'],
skobUi: {
prefix: 'Sk',
tokens: true,
theme: {
skButton: { slots: { root: 'rounded-full' } }
}
}
})Tailwind 3 (@nuxtjs/tailwindcss) #
Модуль добавляет content-пути пака и мержит theme.extend (классы bg-primary-500 и т.п.). Важно: skob-ui должен стоять в modules выше@nuxtjs/tailwindcss — иначе хук tailwindcss:config не сработает (модуль предупредит в консоль).
export default defineNuxtConfig({
// skob-ui ВЫШЕ @nuxtjs/tailwindcss — важно для хука tailwindcss:config
modules: ['skob-ui', '@nuxtjs/tailwindcss']
})Tailwind 4 (@tailwindcss/vite) #
В css приложения — @import "tailwindcss". Модуль сам вколачивает @import "skob-ui/theme.css" и @source на runtime-пак — вручную ничего писать не нужно.
// app/assets/css/main.css
@import "tailwindcss";
// skob-ui/theme.css и @source модуль добавит сам
// nuxt.config.ts
import tailwindcss from '@tailwindcss/vite'
export default defineNuxtConfig({
modules: ['skob-ui'],
vite: { plugins: [tailwindcss()] }
})3. Проверить #
После подключения модуля токены уже в рантайме — проверь палитру любым элементом (первый компонент SkButton уже на подходе):
<div class="rounded bg-primary-500 p-4 text-text-primary">
Токены работают
</div>