@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;