@gouvfr-lasuite/cunningham-tokens

中文文档
3.1.0发布于 2025/12/15MITTypeScriptESM + CJS近 30 天下载 6714

什么是设计标志?

中文使用文档
文档目录8 节
  1. 导言
  2. 开始
  3. 配置文件
  4. 构建
  5. 使用设计符号
  6. 样式表
  7. 字体
  8. Javascript

@gouvfr-lasite/cunningham-takes (英语)

导言

什么是设计标志?

设计符是定义ui组件的精确行为和渲染的基本变量.

例如:

  • 文本元素的主要颜色
  • 两个要素之间的标准间隔
  • 按钮的边框半径
  • .

开始

在本节中,我们将安装库并生成包含您的应用程序设计符号的文件,以便 让坎宁安的设计系统成为你的!

安装 lib

yarn add @gouvfr-lasuite/cunningham-tokens

配置文件

字体

如果您更喜欢使用 Typescript, 请创建名为 文件 cunningham.ts 在您的项目根部

export default {
  theme: {
    colors: {
      primary: "purple",
    },
  },
};

Javascript

或者如果你更喜欢 Javascript, 请创建一个名为 cunningham.cjs 在您的项目根部

module.exports = {
  theme: {
    colors: {
      primary: "purple",
    },
  },
};

在此配置文件中,您可以覆盖设计系统的所有默认值. 您可以找到默认值 这里。 。 。 .

构建

现在把这个脚本添加到您的 package.json

{
    "scripts": {
        ...
        "build-theme": "cunningham -g css"
    }
}

狡猾的CLI的主要目的是构建一个带有您所有定制设计标志的专用CSS,JS,TS文件, 考虑到您的本地配置( 在您先前创建的文件中定义) : cunningham.cjs, (中文(简体) ), 值得一提的是,该文件是可选的,因此将生成包含默认值的文件 设计系统 )

你们可以跑 yarn run cunningham -h 以查看可用的选项.

为了生成符号 css 文件,运行

yarn build-theme

它会生成一个名为文件的文件 cunningham-tokens.css。 。 。 . 别忘了每次你都指挥这个命令 更改内容 cunningham.cjs 档案!

然后,在您主样式表文件上方添加这些行 :

@import "cunningham-tokens"; // Imports the file you just generated.
@import "@gouvfr-lasuite/cunningham-react/style";

都结束了!

您也可以使用 Typescript 或 Javascript 文件生成 -g 选项。 示例 cunningham -g css,ts,js

使用设计符号

样式表

设计符号变量全部在 cunningham-tokens.css 文档。 他们都是前缀 --c 以达到 避免相撞.

以下是一个实例,可以让文本的颜色与主色值一起在 .my-element 匹配元素

.my-element {
  color: var(--c--colors--primary);
}

字体

如果您先前指定 -g ts 选项 cunningham-tokens.ts 生成文件。 你可以把它导入到你的 打印文件并使用这样的设计符号 :

import { tokens } from "./cunningham-tokens";

const myColor = tokens.theme.colors.primary;

Javascript

如果您先前指定 -g js 选项 cunningham-tokens.js 生成文件。 你可以把它导入到你的 Javascript文件并使用这样的设计符号:

import { tokens } from "./cunningham-tokens.js";

const myColor = tokens.theme.colors.primary;

版本与发布记录

@gouvfr-lasuite/cunningham-tokens 共发布 1 个版本,首次发布于 2025/12/15;过去 12 个月发布了 1 个版本。

版本发布日期距今
3.1.0latest2025/12/1511 个月前

关于 @gouvfr-lasuite/cunningham-tokens 的常见问题

@gouvfr-lasuite/cunningham-tokens 是什么?

什么是设计标志?

如何安装 @gouvfr-lasuite/cunningham-tokens?

在项目目录运行 npm install @gouvfr-lasuite/cunningham-tokens,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cunningham,可以用 npx cunningham 直接运行。

@gouvfr-lasuite/cunningham-tokens 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gouvfr-lasuite/cunningham-tokens 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gouvfr-lasuite/cunningham-tokens 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gouvfr-lasuite/cunningham-tokens 可以商用吗?

@gouvfr-lasuite/cunningham-tokens 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gouvfr-lasuite/cunningham-tokens 的下载量有多少?

根据 npm 官方下载统计,@gouvfr-lasuite/cunningham-tokens 在 2026/10/17 – 2026/11/15 这 30 天内被下载 6,714 次,日均约 224 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gouvfr-lasuite/cunningham-tokens 还在维护吗?

最新版本 3.1.0 发布于 2025/12/15(11 个月前);至今共发布 1 个版本,其中过去 12 个月发布了 1 个;首次发布于 2025/12/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。