Chiralkit / UI 套件

ChiralUI

一套视觉系统。所有技术栈。

token、基元和模式只需表达一次,再分别为 React、Web Components 和服务端渲染模板实现。

一条命令安装一个组件。

无需接入任何包,也无需重建主题。组件以普通代码的形式落入你的仓库,你可以阅读,也可以修改。

安装

先运行一次 ck init 检测你的框架,再运行 ck add button。文件会被复制到你的项目中,随时可以提交。

使用

同一个 ds-button 标签可用于 React、Django 模板和纯 HTML,各处的 props 和事件都相同。

保留你的 token,省去重写。

更换设计系统通常意味着重写组件、重命名每一种颜色。ChiralUI 从你已有的东西出发:ck tokens migrate 读取你的 shadcn/ui globals.css 并写出 chiraltokens.css,你的颜色、圆角和字体都已映射到 ChiralUI token。无需 AI,无需 API key。

阅读 shadcn 迁移指南

共享 token 与契约,而不是共享代码。

每个技术栈都读取相同的 @chiralkit/tokens 值、prop 名称和事件名称,因此迁移后的 token 在任何地方含义都一致。注册表更新时,ck update 会先展示差异,再改动你的副本。

UI 套件的六个层级

每个层级都由它之前的两个层级构成——这是把 Chiralkit 分类法应用到 UI 套件所交付的内容上。各环遵循斐波那契数列:0、1、1、2、3、5。token 是一切的起点;到了 2,手性开始出现:每个部件都与它的镜像一起交付,就像一双手。

在《手性架构》中查看跨领域的框架
打开完整的手性场景

Token

环 0

共享词汇——颜色、间距、圆角、字体排印——在 @chiralkit/tokens 中声明一次,由每个技术栈以 CSS 自定义属性的形式使用。

基元

环 1a

直接由 token 构建的单一用途自定义元素:ds-button、ds-badge、ds-code-block。React 用法和模板用法最终都指向同一个标签。

模式

环 1b

由基元组合而成、解决反复出现的交互——对话框、表单、标签页——在各技术栈间遵循相同的 prop 与事件契约。

对映体

环 2

模式的成对特化:共享结构 DNA,并按上下文互为镜像。两张卡片、两种表单模式,与它们之间的过渡契约一起交付。

功能

环 3

端到端的用户流程——登录、结账、设置——由模式和对映体组装而成,可在 React 与服务端模板之间移植。

组合

环 5

布局与页面:把功能排布到界面上的几何结构,以及用户真正看到的完整组合。UI 套件螺旋的顶端。

ChiralFM