43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
# @koko/ui
|
|
|
|
工作台共享 UI 包: shadcn/ui 官方 base-nova(Base UI)组件 50 个 + DatePicker/DateRangePicker + 总体样式 + 基准主题(tweakcn "Light Green")。上游版本见 src/UPSTREAM.json。升级: `npm run sync` → diff → tsc → 发版。
|
|
发布在自建 Gitea npm registry,**匿名可读**——包内不得有任何敏感信息。
|
|
|
|
## 边界(硬规则)
|
|
- 本包只含: 主要组件(`src/components/ui`)、`tokens.css`、`styles.css`、`cn` 工具。
|
|
- 使用方仓库**只允许**覆盖品牌变量: `--primary --primary-foreground --ring --accent --accent-foreground --chart-1 --sidebar-primary --sidebar-primary-foreground --sidebar-ring`。
|
|
- 圆角、字体、间距、组件外观、新增组件、修 bug → **一律回本仓库改并发版**。
|
|
|
|
## 使用方
|
|
```
|
|
# .npmrc (无需 token)
|
|
@koko:registry=https://git.colinx.one/api/packages/koko/npm/
|
|
```
|
|
```
|
|
npm i @koko/ui
|
|
```
|
|
```
|
|
/* app 全局 CSS */
|
|
@import "tailwindcss";
|
|
@import "@koko/ui/styles.css";
|
|
@source "../node_modules/@koko/ui/src";
|
|
|
|
/* 可选: 品牌覆盖(唯一允许的改动) */
|
|
:root { --primary: oklch(...); --ring: oklch(...); }
|
|
```
|
|
```
|
|
import { Button, Card } from "@koko/ui"
|
|
```
|
|
宿主需自备 `react>=19`、`tailwindcss>=4`。
|
|
|
|
## 发版(维护者)
|
|
```
|
|
npm version patch|minor # 改版本
|
|
GITEA_NPM_TOKEN=... npm publish # prepublishOnly 自动跑护栏
|
|
```
|
|
同名同版本不可重发。护栏: `scripts/prepublish-check.mjs`(白名单/敏感信息/体积)。
|
|
|
|
## 文档
|
|
- [docs/USAGE.md](docs/USAGE.md) 使用方规范(接入、可改/不可改、验证)
|
|
- [docs/MAINTAINING.md](docs/MAINTAINING.md) 维护规范(同步上游、**自研组件准入: 至少 2 个项目在用**、发版护栏)
|