c3-ui (1.2.21)
Installation
registry=https://gitea.chizhik.net/api/packages/yurgeman/npm/npm install c3-ui@1.2.21"c3-ui": "1.2.21"About this package
c3-ui
Customizable Company Core UI Nuxt module.
Features
- 🎨 Генерация CSS-переменных цветов из палитры
Quick Setup
Install the module to your Nuxt application with one command:
bunx nuxt module add c3-ui
That's it! You can now use c3-ui in your Nuxt app ✨
Установка из приватного реестра
Модуль публикуется в приватный npm-реестр Gitea (gitea.env-dev.ru). Для установки добавьте в .npmrc проекта:
registry=https://gitea.chizhik.net/api/packages/yurgeman/npm/
//gitea.chizhik.net/api/packages/yurgeman/npm/:_authToken=<GITEA_TOKEN>
//gitea.chizhik.net/api/packages/yurgeman/npm/:strict-ssl=false
<GITEA_TOKEN> — токен из Gitea: Settings → Applications → Generate New Token (достаточно права read:package).
После этого установите модуль:
bunx nuxt module add c3-ui
или вручную:
bun add c3-ui
У пакета
c3-uiнет scope, поэтому npm не может адресовать приватный реестр только для него —registry=применяется ко всем пакетам. Если проекту нужны и публичные пакеты, указывайте реестр разово через флаг:bun add c3-ui --registry=https://gitea.env-dev.ru/api/packages/yurgeman/-/npm/
Если сертификат Gitea самоподписанный и установка падает с
UNABLE_TO_VERIFY_LEAF_SIGNATURE, добавьте вbunfig.tomlпроекта:[install] ca = ["/path/to/gitea-ca.pem"]либо на разовую установку:
NODE_TLS_REJECT_UNAUTHORIZED=0 bun add c3-ui.
Цвета (Palette)
Модуль генерирует SCSS-файл src/runtime/assets/styles/_colors.scss с CSS-переменными цветов из палитры с префиксом
c3.
Формат палитры
Палитра задаётся в JSON-файле (по умолчанию assets/palette/palette.json) и имеет структуру
цвет → оттенок → значение:
{
"primary": {
"500": "#b8c748"
},
"textColor": {
"500": "#2c2d23"
}
}
Использование
Запустите генерацию, передав путь к файлу палитры:
bun run generate:colors -- assets/palette/palette-1785492113876.json
Без аргумента скрипт возьмёт файл assets/palette/palette.json.
На выходе создаётся/обновляется файл _colors.scss:
:root {
--c3-primary-500: #b8c748;
--c3-text-color-500: #2c2d23;
}
Названия цветов приводятся к kebab-case (textColor → --c3-text-color-500).
Contribution
Local development
# Install dependencies
bun install
# Generate type stubs
bun run dev:prepare
# Develop with the playground
bun run dev
# Build the playground
bun run dev:build
# Run ESLint
bun run lint
# Run Vitest
bun run test
bun run test:watch
# Run TypeScript checks
bun run test:types
# Generate CSS color variables from palette
bun run generate:colors
# Release new version
bun run release
Dependencies
Dependencies
| ID | Version |
|---|---|
| @nuxt/kit | ^4.5.2 |
| sass | ^1.102.0 |
| sass-loader | ^17.0.0 |
Development Dependencies
| ID | Version |
|---|---|
| @nuxt/devtools | ^3.4.1 |
| @nuxt/eslint-config | ^1.17.0 |
| @nuxt/module-builder | ^1.0.3 |
| @nuxt/schema | ^4.5.2 |
| @nuxt/test-utils | ^4.1.0 |
| @storybook/addon-a11y | 10.5.8 |
| @storybook/vue3 | 10.5.8 |
| @storybook/vue3-vite | 10.5.8 |
| @types/node | latest |
| @vitejs/plugin-vue | 6.0.8 |
| @vitest/expect | 4.1.10 |
| @vitest/spy | 4.1.10 |
| @vitest/utils | 4.1.10 |
| @vue/test-utils | ^2.4.11 |
| changelogen | ^0.6.2 |
| eslint | ^10.8.1 |
| eslint-config-prettier | ^10.1.8 |
| happy-dom | ^20.11.2 |
| nuxt | ^4.5.2 |
| prettier | ^3.9.6 |
| standard-version | ^9.5.0 |
| storybook | 10.5.8 |
| typescript | ~6.0.3 |
| unbuild | ^3.6.1 |
| vitest | ^4.1.10 |
| vitest-environment-nuxt | ^2.0.0 |
| vue | 3.5.41 |
| vue-tsc | ^3.3.10 |