# @cypress-design/css 中文文档

规范地址：https://npmcn.com/package/%40cypress-design/css/

版本：1\.3\.0
npm 元数据更新时间：2026-06-11T13:33:50.985Z
中文译文更新时间：2026-11-11T07:14:53.724Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cypress-design/css
原文对照：https://npmcn.com/package/%40cypress-design/css/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：365 kB，63 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2022-04-30T02:40:43.479Z
- 最新版本发布：2026-06-11T13:33:50.872Z
- 近 30 天下载量：18193（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 1 个）

## 中文简介

我们使用一个通用的首个 CSS 框架: TailwindCSS 来设置每个组件。 在您的工程中安装, 以正确配置组件 .

## 安装

```sh
npm install @cypress-design/css
```

也可以使用：`pnpm add @cypress-design/css`、`yarn add @cypress-design/css`、`bun add @cypress-design/css`

## README

# @ cypress- design/ css (简体中文)

我们使用一个通用的首个 CSS 框架: TailwindCSS 来设置每个组件. 在您的工程中安装, 以正确配置组件 .

为此,遵循以下两个步骤:

## 在您的依赖性中安装 CSS 软件包 :

```bash
yarn add -D @cypress-design/css
```

## 类型

设计系统采用三个品牌字体. 通过Google Fonts装入它们——CDN处理横跨Cypress产品的缓冲:

```html
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,400;0,500;0,600;0,700;1,400&family=Roboto:ital,wght@0,400;0,500;0,700;1,400&family=Roboto+Mono:wght@400;500;600;700&display=swap"
/>
```

此套件所暴露的 Tailwind 字体工具 :

| 类 | 字体 | 用于 |
| --- | --- | --- |
| `font-brand-heading` | 弹出 | 页面标题, 显示文本 |
| `font-brand` | 机器人 | 机体复制, UI 标签 |
| `font-brand-mono` | 单人机器人 | 代码、 符号、 单相距值 |
| `font-system` | 系统搜索堆栈 | 后退/ 系统 UI |
| `font-system-mono` | 系统单空间堆栈 | 倒置/ 系统 UI 单 |
| `font-mono` | 系统单空间堆栈 | 方便用别名 `font-system-mono` |

## 对于使用此软件包的项目:

我们把所有导入到这个包中的任何文件的 cs 绑入一个 dist 文件夹中的文件.. `index.css` 这样,这个软件包的用户就可以导入这个软件包的 css 样式,并在他们的工程中使用.

### 在样式表中使用 cyColors

在制作这个软件包时,我们有一个脚本 `generate-colors-css.ts` 生成文件 `colors.css` 重新创建所有 `cyColors` 从 `color-constants.ts` 作为 cs 变量。 如果需要添加或更新颜色,则仅指对象 `cyColors` 内 `color-constants.ts` 需要更新。 然后,我们需要重建 一揽子,以便 `colors.css` 可以重新生成, 因此您应该运行 :

```base
cd css && yarn build
```

### 要使用此软件包在项目中使用这些 css 变量:

在你身边 `.css` 文件添加 :

```
@import "@cypress-design/css/index.css";
```

在你身边 `.scss` 文件添加 :

```
@use "@cypress-design/css/index.css" as *
```

然后可以使用来自 `colors.css` 像这样:

```
border: 1px solid var(--cy-gray-800);
```

## 删除 Windi (如果安装)

如果安装了风格,请先解开:

-   删除用于风向的自定义导入 `import 'virtual:windi.css'`
-   从 web 软件包或 vite 配置中删除插件

## 安装尾风

安装尾风: 跟随 [尾风文件](https://tailwindcss.com/docs/installation/using-postcss)

最后更新尾风配置文件 .

### 最简单的方式

此配置的动词较少, 只允许您自定义扫描的文件 .

```js
// tailwind.config.cjs
const { TailwindConfig } = require('@cypress-design/css')

module.exports = TailwindConfig([
  './index.html',
  './src/**/*.{vue,js,ts,jsx,tsx}',
])
```

### 明确的方式

如果你计划配置

```js
// tailwind.config.cjs
const cypressCSS = require('@cypress-design/css')

/** @type {import('tailwindcss').Config} */
module.exports = {
  presets: [cypressCSS.TailwindConfig()],
  content: {
    files: ['./index.html', './src/**/*.{vue,js,ts,jsx,tsx}'],
    extract: ['vue', 'js', 'tsx'].reduce((acc, ext) => {
      acc[ext] = cypressCSS.TailwindIconExtractor
      return acc
    }, {}),
  },
}
```

## 安装 WindiCSS( 过期)

### 网络软件包

```js
const { CyCSSWebpackPlugin } = require('@cypress-design/css')

module.exports = {
  plugins: [
    CyCSSWebpackPlugin({
      scan: {
        include: ['src/**/*.@(tsx|ts|js|vue)'],
      },
    }),
  ],
}
```

### 维特

```js
import { defineConfig } from 'vite'
import { CyCSSVitePlugin } from '@cypress-design/css'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    CyCSSVitePlugin({
      scan: {
        include: ['/src/**/*.@(tsx|ts|js|vue)'],
      },
    }),
  ],
})
```

> **页:1**: 将您的 html 页面和所有的反应和 vue 组件文件添加到 `scan.include` 阵列. 这有助于WindiCSS确定在最终生成的CSS中包含哪个类.

## 常见问题

### @cypress-design/css 是什么？

我们使用一个通用的首个 CSS 框架: TailwindCSS 来设置每个组件。 在您的工程中安装, 以正确配置组件 \.

### 如何安装 @cypress-design/css？

在项目目录运行 npm install @cypress-design/css，或使用 pnpm add / yarn add / bun add。

### @cypress-design/css 支持 TypeScript 吗？

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

### @cypress-design/css 支持 ESM 还是 CommonJS？

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

### @cypress-design/css 可以商用吗？

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

### @cypress-design/css 的下载量有多少？

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

### @cypress-design/css 还在维护吗？

最新版本 1\.3\.0 发布于 2026/06/11（4 个月前）；至今共发布 43 个版本，其中过去 12 个月发布了 1 个；首次发布于 2022/04/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。