# @gentleduck/variants 中文文档

规范地址：https://npmcn.com/package/%40gentleduck/variants/

版本：1\.0\.0
npm 元数据更新时间：2026-05-30T06:22:40.753Z
中文译文更新时间：2026-11-16T04:11:55.861Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gentleduck/variants
原文对照：https://npmcn.com/package/%40gentleduck/variants/?lang=original
项目主页：https://gentleduck.org/duck-ui
源码仓库：https://github.com/gentleeduck/gentleduck

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

- 包体积（解压后）：14.5 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- 首次发布：2025-08-04T19:33:57.281Z
- 最新版本发布：2026-05-30T06:22:40.637Z
- 近 30 天下载量：3066（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 8 个）

## 中文简介

用于创建组件变体的软件包,为创建组件变体提供了简单而有效的方法.

## 安装

```sh
npm install @gentleduck/variants
```

也可以使用：`pnpm add @gentleduck/variants`、`yarn add @gentleduck/variants`、`bun add @gentleduck/variants`

## README

![@gentleduck/variants](https://npmcn.com/package/public/logo-dark.svg)

# @ gentleduck/ 变量

具有 " cva () " 的型号安全组件变体.

[麻省理工学院](https://npmcn.com/package/LICENSE) - 说吧 [更改日志](https://npmcn.com/package/CHANGELOG.md) - 说吧 [捐款](https://npmcn.com/package/CONTRIBUTING.md) - 说吧 [文档](https://gentleduck.org/duck-ui)

[![npm](https://img.shields.io/npm/v/@gentleduck/variants.svg)](https://www.npmjs.com/package/@gentleduck/variants) [![downloads](https://img.shields.io/npm/dm/@gentleduck/variants.svg)](https://www.npmjs.com/package/@gentleduck/variants) [![MIT](https://img.shields.io/npm/l/@gentleduck/variants.svg)](https://npmcn.com/package/LICENSE)

* * *

类型安全组件变体 `cva()`。 。 。 .

定义有完整TypeScript推断,复合变体,和默认值的变体驱动类名. 零从属.

## 快开始

```bash
npm install @gentleduck/variants
```

```ts
import { cva, type VariantProps } from '@gentleduck/variants'

const button = cva('px-4 py-2 rounded font-medium', {
  variants: {
    intent: {
      primary: 'bg-blue-600 text-white',
      secondary: 'bg-gray-100 text-gray-800',
    },
    size: {
      sm: 'text-sm px-3 py-1',
      md: 'text-base px-4 py-2',
      lg: 'text-lg px-6 py-3',
    },
  },
  defaultVariants: {
    intent: 'primary',
    size: 'md',
  },
  compoundVariants: [
    { intent: 'primary', size: 'lg', className: 'uppercase tracking-wide' },
  ],
})

button()                          // default: primary + md
button({ intent: 'secondary' })  // secondary + md
button({ size: 'lg' })           // primary + lg + compound applied

type ButtonVariants = VariantProps<typeof button>
```

## 特征

-   **化合物变体** -- 当多个变量值匹配时应用分类
-   **默认变体** -- 无道具传递时的倒置值
-   **类型推论** - 说吧 `VariantProps<typeof fn>` 提取组件接口的变体道具
-   **可编曲** - 通过一个 `cva()` 由另一个基数产生 `cva()` 调用
-   **阵列和对象** -- 支持嵌入类阵列和有条件的对象
-   **零依赖关系** - 没有运行时间道克, `"sideEffects": false`

## 基准

这个包装一个基准脚本来比较 `@gentleduck/variants` 反对 `class-variance-authority`, (中文(简体) ), `tailwind-variants`,以及 `clsx` 横跨三轴:

-   **套装大小** (叹气): `shipped` (原始文件 npm 服务), `fullApi` (散会) `export *`精炼而成的, `realImport` (用副作用槽捆绑主要导出,精细化——应用实际支付多少).
-   **运行时间** (ns/op):四种情况(默认,一个变体,变体+大小,有类名合并),各在 `warm` 模式(重复使用相同的道具——有利于纪念库)和 `cold` 模式(每个调用的独特类Name – 击败记忆)。 报告中位数,p95,p99,stdev,以及相对误差幅度.
-   **特征**:自我报告的能力矩阵.

### 运行

```bash
# from this package
bun run benchmark

# from the monorepo root
bun run benchmark:variants
```

输出写入 `public/benchmarks/results.json` 并镜像到 `apps/duck-ui-docs/public/data/benchmarks/variants.json`。每个 JSON 包括主机环境(CPU、节点、包子、平台、git 承诺)、墙上小时和a `reproCommand` 绳取出处.

### 如何读取数字

纪念是图书馆的一流特色,所以 `warm` 模式反映了它的最佳情况。 这个 `cold` 报告模式的同时,还诚实地显示非计量成本——这比起没有记忆的图书馆来说是一个更公平的数字. Bundle大小是静态的;运行时数取决于机器,应该相对于同一运行中的其他库来解释,而不是绝对常数.

## 文档

[温特多克.org](https://gentleduck.org/)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40gentleduck/variants/LICENSE)

## 常见问题

### @gentleduck/variants 是什么？

用于创建组件变体的软件包,为创建组件变体提供了简单而有效的方法\.

### 如何安装 @gentleduck/variants？

在项目目录运行 npm install @gentleduck/variants，或使用 pnpm add / yarn add / bun add。

### @gentleduck/variants 支持 TypeScript 吗？

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

### @gentleduck/variants 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gentleduck/variants 需要什么版本的 Node\.js？

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

### @gentleduck/variants 可以商用吗？

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

### @gentleduck/variants 的下载量有多少？

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

### @gentleduck/variants 还在维护吗？

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

