# @eqtylab/equality 中文文档

规范地址：https://npmcn.com/package/%40eqtylab/equality/

版本：5\.4\.2
npm 元数据更新时间：2026-11-10T15:57:10.664Z
中文译文更新时间：2026-11-13T20:04:34.850Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40eqtylab/equality
原文对照：https://npmcn.com/package/%40eqtylab/equality/?lang=original
项目主页：https://equality.eqtylab.io/
源码仓库：https://github.com/eqtylab/equality

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

- 包体积（解压后）：2.5 MB，106 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：28 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.0\.0，react-dom ^18\.2\.0 \|\| ^19\.0\.0
- 首次发布：2026-01-27T18:43:43.619Z
- 最新版本发布：2026-11-10T15:57:10.158Z
- 近 30 天下载量：9939（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：111（近 12 个月 111 个）

## 中文简介

EQTYLab 组件和以符号为基础的设计系统

## 安装

```sh
npm install @eqtylab/equality
```

也可以使用：`pnpm add @eqtylab/equality`、`yarn add @eqtylab/equality`、`bun add @eqtylab/equality`

## README

# @eqtylab/ 平等

[![npm version](https://img.shields.io/npm/v/@eqtylab/equality)](https://www.npmjs.com/package/@eqtylab/equality) [![license](https://img.shields.io/npm/l/@eqtylab/equality)](https://github.com/eqtylab/equality/blob/main/LICENSE)

EQTY Lab的设计系统:可访问的React组件和设计符号,以Radix UI和Tailwind CSS v4为主.

**[文档](https://equality.eqtylab.io/)** • 妇女 **[构成部分](https://equality.eqtylab.io/components/button/)** • 妇女 **[GitHub 图像](https://github.com/eqtylab/equality)**

## 安装

```bash
npm install @eqtylab/equality
# or
pnpm add @eqtylab/equality
# or
yarn add @eqtylab/equality
```

要求数 `react` 财务报告和审定财务报表 `react-dom` 18.2或更新鲜.

## 设置

### 尾风 CSS v4( 建议)

在您的全局样式表中导入主题配置, 然后导入飞行前:

```css
@import '@eqtylab/equality/theme-config.css';
@import '@eqtylab/equality/preflight.css' layer(base);
```

`theme-config.css` 因为它宣布了飞行前所依赖的层序。 它建立在尾风上 所以 `tailwindcss` v4 必须在您的工程中安装 .

| 样式表 | 包含 |
| --- | --- |
| `@eqtylab/equality/theme-config.css` | 手提箱、主题、公用事业和部件。 没有重置 . |
| `@eqtylab/equality/preflight.css` | 基础样式重置 `html` 和它下的所有东西. |
| `@eqtylab/equality/preflight-scoped.css` | 同样的重置,只在内部 `[data-equality-root]`。 。 。 . |

如果将平等植入一个具有自身基础风格的网站,请使用 `preflight-scoped.css` 因此重置不会影响其他页面.

### 没有尾风

包装您的应用程序, 或使用平等的部分, 在 `ThemeProvider`数字 :

```tsx
import { ThemeProvider } from '@eqtylab/equality';

export function Root() {
  return (
    <ThemeProvider>
      <App />
    </ThemeProvider>
  );
}
```

见 [使用指南](https://equality.eqtylab.io/getting-started/usage/) 用于嵌入主机站点, 阴影 DOM, 以及传送到的表面.

## 使用量

```tsx
import { Button, Card, CardContent } from '@eqtylab/equality';

export function Example() {
  return (
    <Card>
      <CardContent>
        <Button>Save changes</Button>
      </CardContent>
    </Card>
  );
}
```

每个组件接受a `className` 本地样式覆盖的道具 。 组件样式被用 CSS 模块进行范围化,因此覆盖不会泄露到其他组件.

## 主题

平等船舶 `light` 财务报告和审定财务报表 `dark` 主题。 将活动主题设置在根元素上 :

```html
<html data-equality-theme="dark"></html>
```

在第一次油漆之前应用存储或系统偏好,请将 `initializeTheme` 文档中的脚本 `<head>`数字 :

```tsx
import { initializeTheme } from '@eqtylab/equality/scripts';

<head>
  <script>{initializeTheme()}</script>
</head>;
```

见 [主题](https://equality.eqtylab.io/getting-started/themes/) 选项.

## 入境点

| 导入路径 | 目录 |
| --- | --- |
| `@eqtylab/equality` | 组件, `ThemeProvider`和钩子 |
| `@eqtylab/equality/scripts` | `initializeTheme` 主题启动的内置脚本 |
| `@eqtylab/equality/syntax-language` | CodeBlock 语法绘图文件名 |
| `@eqtylab/equality/theme-config.css` | 尾风 v4 主题配置 |
| `@eqtylab/equality/preflight.css` | 全球基础样式重置 |
| `@eqtylab/equality/preflight-scoped.css` | 基准样式重设范围到 `[data-equality-root]` |

包船ES模块和CommonJS以TypeScript类型来构建.

## 无障碍

构件基于 [Radix 用户界面](https://www.radix-ui.com/) 原始并被设计为键盘导航和屏幕阅读器.

## 许可证

[阿帕奇 - 2.0](https://github.com/eqtylab/equality/blob/main/LICENSE)

## 常见问题

### @eqtylab/equality 是什么？

EQTYLab 组件和以符号为基础的设计系统

### 如何安装 @eqtylab/equality？

在项目目录运行 npm install @eqtylab/equality，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.0\.0）、react-dom（^18\.2\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eqtylab/equality 支持 TypeScript 吗？

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

### @eqtylab/equality 支持 ESM 还是 CommonJS？

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

### @eqtylab/equality 可以商用吗？

@eqtylab/equality 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @eqtylab/equality 的下载量有多少？

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

### @eqtylab/equality 还在维护吗？

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