# @dt-dds/react-checkbox 中文文档

规范地址：https://npmcn.com/package/%40dt-dds/react-checkbox/

版本：1\.0\.0-beta\.76
npm 元数据更新时间：2026-11-13T11:45:56.482Z
中文译文更新时间：2026-11-12T23:04:01.424Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dt-dds/react-checkbox
原文对照：https://npmcn.com/package/%40dt-dds/react-checkbox/?lang=original

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

- 包体积（解压后）：42.6 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react \>=17\.0\.2，react-dom \>=17\.0\.2，@emotion/css ^11\.7\.1，@emotion/react ^11\.8\.2，@emotion/styled ^11\.8\.1
- 首次发布：2025-08-07T08:03:36.031Z
- 最新版本发布：2026-11-13T11:45:56.267Z
- 近 30 天下载量：3511（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 27 个）

## 中文简介

复选框在检查状态和未选中状态之间切换,使用户能够在形式和设置中作出二进制选择 .

## 安装

```sh
npm install @dt-dds/react-checkbox
```

也可以使用：`pnpm add @dt-dds/react-checkbox`、`yarn add @dt-dds/react-checkbox`、`bun add @dt-dds/react-checkbox`

## README

# 复选框

复选框在检查状态和未选中状态之间切换,使用户能够在形式和设置中作出二进制选择 .

## 图片参考

[图片](https://www.figma.com/design/kMk36nv0ZT4AHhBbw9jq0S/%E2%86%B3-1.-Daimler-Truck-DDS--Beta-?node-id=4973-18002&t=Q2vzJQbSCO9jHwxx-4)

## 复选框使用

```jsx
import { Checkbox } from '@dt-dds/react-checkbox';
import { useState } from 'react';

export const App = () => {
  const [checked, setChecked] = useState(false);

  const handleChange = (evt) => {
    setChecked(evt.target.checked);
  };

  return (
    <Checkbox checked={checked} onChange={handleChange}>
      Accept terms and conditions
    </Checkbox>
  );
};
```

## 不确定的国家

```jsx
const [checkedItems, setCheckedItems] = useState([false, false, false]);

const allChecked = checkedItems.every(Boolean);
const isIndeterminate = checkedItems.some(Boolean) && !allChecked;

<Checkbox
  checked={allChecked}
  indeterminate={isIndeterminate}
  onChange={(e) =>
    setCheckedItems([e.target.checked, e.target.checked, e.target.checked])
  }
>
  Select all
</Checkbox>;
```

## 属性

| 财产 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| 已检查 | `boolean` | —— 说 | 控制选中状态 |
| 变化 | `(evt: ChangeEvent<HTMLInputElement>) => void` | —— 说 | 州变后调回. |
| 已失效 | `boolean` | `false` | 若为 `true`,复选框已禁用. |
| 不确定 | `boolean` | `false` | 若为 `true`,复选框以不确定状态出现. |
| 有错误 | `boolean` | `false` | 若为 `true`,复选框显示错误状态. |
| 大小 | `'small' | 'large'` | `'large'` | 复选框大小 . |
| 标签 | `ReactNode` | —— 说 | 要显示为标签的文本或元素 . |
| 儿童 | `ReactNode` | —— 说 | 提供标签内容的替代方式. |
| 数据测试 | `string` | `'checkbox'` | 测试库的测试标识符 . |
| 编号 | `string` | —— 说 | HTML 语言 `id` 输入元素属性. |
| 离子标签 | `string` | —— 说 | 无障碍标签(如果没有) `label` 或者说 `children` (提供). |
| 样式 | `CSSProperties` | —— 说 | 包装的内含样式. |
| 参考 | `Ref<HTMLInputElement>` | —— 说 | 已转发到输入元素 . |

### 说明

除上述属性外,该组件还接受一个小项的所有标准道具 `input` 键.

## 堆栈

-   [类型脚本](https://www.typescriptlang.org/) 用于静态类型检查
-   [反应](https://reactjs.org/) — JavaScript 用户界面库
-   [情感](https://emotion.sh/docs/introduction) 用于使用 JavaScript 写入 Css 样式
-   [故事书](https://storybook.js.org/) ——由Vite供电的UI组件环境
-   [欢乐](https://jestjs.io/) - JavaScript 测试框架
-   [反应测试库](https://testing-library.com/) - 以用户为中心测试用户界面组件
-   [ESLint 语录](https://eslint.org/) 代码林入
-   [高级](https://prettier.io/) 用于代码格式
-   [苏普](https://github.com/egoist/tsup) - 由Esbuild供电的脚本捆绑机
-   [雅伦](https://yarnpkg.com/) 从管理软件包

## 图标

-   `yarn build` - 制作软件包
-   `yarn dev` - 在当地运行软件包
-   `yarn lint` - 将所有文件输入此软件包
-   `yarn test` 运行所有单位测试
-   `yarn test:report` - 打开测试覆盖报告
-   `yarn test:update:snapshot` - 进行所有单元测试并更新快照

## 汇编

运行 `yarn build` 从软件包的根部 [齐声](https://tsup.egoist.dev/) 将原始的 TypeScript 和 React 代码编译为普通 JavaScript .

这个 `/dist` 文件夹包含编译输出.

```bash
checkbox
└── dist
    ├── index.d.ts  <-- Types
    ├── index.js    <-- CommonJS version
    └── index.mjs   <-- ES Modules version
    ...
```

## 版本

跟着 [语义版本](https://semver.org/)

## 许可证

许可证根据 [MIT 许可证](https://npmcn.com/package/%40dt-dds/react-checkbox/LICENSE)

## 常见问题

### @dt-dds/react-checkbox 是什么？

复选框在检查状态和未选中状态之间切换,使用户能够在形式和设置中作出二进制选择 \.

### 如何安装 @dt-dds/react-checkbox？

在项目目录运行 npm install @dt-dds/react-checkbox，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=17\.0\.2）、react-dom（\>=17\.0\.2）、@emotion/css（^11\.7\.1）、@emotion/react（^11\.8\.2）、@emotion/styled（^11\.8\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dt-dds/react-checkbox 支持 TypeScript 吗？

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

### @dt-dds/react-checkbox 支持 ESM 还是 CommonJS？

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

### @dt-dds/react-checkbox 可以商用吗？

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

### @dt-dds/react-checkbox 的下载量有多少？

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

### @dt-dds/react-checkbox 还在维护吗？

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