跳至正文
文档

Registry & NamespacesRegistry 与命名空间

通过 URL 或 @yiui 命名空间安装条目,了解目录地址、各类条目与依赖关系。

本站的所有条目都以 JSON 形式静态发布在 /r/ 下,格式遵循 shadcn 的 registry-item 规范。开始之前请先按安装初始化 shadcn(Base UI 底座)。

URL 安装

每个条目都有固定地址 https://yiui.dev/r/<name>.json,直接交给 CLI 即可,不需要配置:

终端
pnpm dlx shadcn@latest add https://yiui.dev/r/grid-layout.json

配置命名空间

在项目的 components.json 中合并以下配置。若已有其他 Registry,请保留原有条目。

components.json
{
  "registries": {
    "@yiui": "https://yiui.dev/r/{name}.json"
  }
}

CLI 会把条目名代入 {name},于是命令可以缩短为:

终端
pnpm dlx shadcn@latest add @yiui/grid-layout

两种方式装出来的文件和样式完全一样。

条目目录

完整的条目清单位于 /r/registry.json,包含每个条目的类型、依赖与文件列表。可以用它做检索,也可以交给脚本或 AI 工具读取。

也可以用 CLI 直接查看(需要先配置命名空间):

终端
pnpm dlx shadcn@latest search @yiui
pnpm dlx shadcn@latest view @yiui/grid-layout

search 列出全部条目及说明,view 输出条目的完整 JSON,包含每个文件的源码。装之前想知道会写入哪些文件,可以给 add 加 --dry-run。

条目类型

类型内容示例
registry:ui单个组件,安装到 components/ui/<name>/grid-layout
registry:block区块,由多个文件和组件组成,页面文件写入 app/auth-01
registry:page整页模板,会写入 app/ 下的页面与布局app-shell-01
registry:theme颜色主题,只写入 CSS 变量,会改写已有的同名变量theme-blue

文件的具体落点、样式写入的内容见安装。

依赖关系

条目之间通过 registryDependencies 相互依赖,值有两种:

  • shadcn 官方组件名,如 button、input,由 CLI 按你项目的底座生成。
  • 本站其他条目的完整地址,如 https://yiui.dev/r/flow-diagram.json。

安装时依赖会递归解析、一起装上,所以即便你用 @yiui/... 命名空间,CLI 取依赖条目时访问的仍是 https://yiui.dev/r/ 下的地址。已存在的文件默认会提示是否覆盖,处理方式见安装。

大层级依赖小层级:区块和模板由组件拼成,组件之间也有依赖,例如 value-slider 依赖 flow-diagram,flow-diagram 再依赖 grid-layout。每个条目页的「命令」标签会列出会连带安装的内容,「手动」标签给出完整的依赖清单。