安装

添加一次 registry,然后用 shadcn CLI 安装组件。

1. 添加 registry

打开 components.json,把 Wobko 加进 registries。每个项目只需做一次。

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

免费内容不需要账号,也不需要密钥。

2. 安装一个组件

terminal
npx shadcn@latest add @wobko/button

CLI 会把组件写入你的 ui 目录,把绘制代码写入 lib/ink,把主题写入你的 Tailwind CSS 文件,并安装组件需要的 npm 包。

一次安装全部组件:

terminal
npx shadcn@latest add @wobko/wobko

主题会改变你的配色

每个组件都依赖 Wobko 主题。安装主题会把 shadcn 的颜色变量(--background、--primary 等)设置成纸张配色。项目里已有的其他 shadcn 组件也会跟着变色。

3. 用 Provider 包住应用

Provider 保存所有绘制都会读取的设置,在靠近根节点的位置放一次即可。

tsx
import { InkProvider } from "@/lib/ink/react"

export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="zh">
      <body>
        <InkProvider>{children}</InkProvider>
      </body>
    </html>
  )
}

4. 开始使用

tsx
import { Button } from "@/components/ui/button"

export function Save() {
  return <Button>保存修改</Button>
}

Next.js

需要浏览器环境的组件自带 "use client",在 App Router 里可以直接从 Server Component 导入。

遇到问题时

  • CLI 找不到 @wobko。 确认 registries 配置写在你运行命令的那个项目的 components.json 里。
  • 组件渲染出来没有手绘效果。 确认页面被 InkProvider 包住,并且主题已经写入你的 Tailwind CSS 文件。
  • 文字不是手写字体。 主题会加载 Kevin Sans。如果你的 CSS 构建流程把它丢掉了,可以手动加载字体,见主题。