Foundations
Registry & Theme JSON
组件 registry、主题 schema 与主题预设的静态分发
P2-B 起,组件登记与主题契约除文档页外还提供机器可读的静态 JSON,供 AI 编码代理、CLI 与主题编辑器消费。
端点
| 路径 | 内容 |
|---|---|
/r/registry.json | @mox-hub/ui 全部组件条目 |
/r/patterns.json | @mox-hub/patterns 全部模式条目 |
/r/theme.schema.json | ThemeConfig 的 JSON Schema(draft 2020-12) |
/r/themes/default.json | 默认主题意图 |
/r/themes/{baseColor}.json | neutral / slate / zinc / stone / gray 基础色预设 |
/r/themes/ordo.json | Ordo 品牌预设 |
curl https://ordo-ui.netlify.app/r/registry.json
curl https://ordo-ui.netlify.app/r/themes/ordo.jsonregistry.json
顶层字段:
| 字段 | 说明 |
|---|---|
name / version | 包名与当前版本 |
homepage | 文档站地址 |
items | 组件条目数组 |
条目字段:
| 字段 | 说明 |
|---|---|
name | 组件名,与 registry.ts 一致 |
type | registry:ui(ui)或 registry:block(patterns) |
status | canonical / standby / internal / review / deprecated |
description | 用法摘要(来自 aiNotes) |
files | 包内源文件路径 |
dependencies | 组件递归 import 到的 npm 包(过滤为 package.json 的 deps / peers) |
registryDependencies | 同包内直接或间接引用的组件名 |
variants / defaultVariants | 变体轴与默认值(来自 variantAxes) |
docs | 对应文档页 URL |
registry.json 与 registry.ts 同源;修改 registry 后运行:
pnpm --filter @mox-hub/ui gen:registry
pnpm --filter @mox-hub/patterns gen:registryCI 的 lint:registry-json 会对账,漂移即失败。
theme.schema.json
Schema 的枚举从 src/theme/types.ts 的字面量联合类型提取,locale 枚举从 src/i18n/messages 目录提取:
baseColor:neutral/slate/zinc/stone/grayradius:none/sm/md/lg/xldensity:compact/comfortable/spaciousmotion:full/reduced/nonecontrast:normal/highdirection:ltr/rtllocale:zh-CN/en-USbrand.primary/primaryForeground/ring:HSL 三元组,如216 42% 50%
{
"baseColor": "zinc",
"radius": "lg",
"density": "compact",
"direction": "rtl",
"locale": "en-US",
"brand": {
"primary": "216 42% 50%",
"primaryForeground": "0 0% 100%",
"ring": "216 42% 50%"
}
}生成与对账:
pnpm --filter @mox-hub/ui gen:theme-schema
pnpm --filter @mox-hub/ui lint:theme-schema包内取用
发布包里同时包含 JSON 文件,可直接按子路径导入:
import uiRegistry from '@mox-hub/ui/registry.json'
import themeSchema from '@mox-hub/ui/theme.schema.json'
import patternsRegistry from '@mox-hub/patterns/registry.json'主题 JSON 的 config 可直接传给 defineTheme() / ThemeProvider;tokens.light 与 tokens.dark 是预设的 HSL 变量表,供编辑器预览或导出 CSS。