# @cdx-ui/web 中文文档

规范地址：https://npmcn.com/package/%40cdx-ui/web/

版本：0\.3\.12
npm 元数据更新时间：2026-11-04T15:33:30.197Z
中文译文更新时间：2026-11-09T13:30:28.984Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cdx-ui/web
原文对照：https://npmcn.com/package/%40cdx-ui/web/?lang=original
项目主页：https://github.com/dfh-candescent/forge-design-system#readme
源码仓库：https://github.com/dfh-candescent/forge-design-system

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

- 包体积（解压后）：214 kB，143 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：vite \>=6\.0\.0，react ^18\.2\.0 \|\| ^19\.0\.0，vitest \>=3\.0\.0，uniwind \>=1\.10\.0，tailwindcss \>=4\.3\.0，react-native \>=0\.76\.0，react-native-web \>=0\.19\.0，@tailwindcss/vite \>=4\.3\.0
- 首次发布：2026-08-19T17:17:58.719Z
- 最新版本发布：2026-11-04T15:33:30.019Z
- 近 30 天下载量：2547（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 62 个）

## 中文简介

在React web应用程序中使用Forge UI的Vite集成.

## 安装

```sh
npm install @cdx-ui/web
```

也可以使用：`pnpm add @cdx-ui/web`、`yarn add @cdx-ui/web`、`bun add @cdx-ui/web`

## README

# @cdx-ui/网络

在React web应用程序中使用Forge UI的Vite集成.

## 安装

安装 `@cdx-ui/web` 与您其他 Forge UI 软件包相同的版本 :

```bash
npm install --save-dev @cdx-ui/web vite @tailwindcss/vite tailwindcss uniwind
```

## 配置维特( V) (`forge()`(中文(简体) )

添加 `forge()` 在 React 插件之前,并将其指向您的应用程序的 CSS 条目文件 :

```ts
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { forge } from '@cdx-ui/web/vite';

export default defineConfig({
  plugins: [forge({ cssEntryFile: 'src/index.css' }), react()],
});
```

`forge()` 配置 Tailwind 和 Uniwind, React 本地 Web 分辨率, 依赖性预捆绑, 和Forge UI所要求的兼容设置.

### `forge()` 选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `cssEntryFile` | `string` | —— 说 | 应用程序的 CSS 条目文件的相对路径 . |
| `patchWorklets` | `boolean` | `true` | 应用 React 本地工作板兼容补丁. |

## 使用 Vitest 进行测试( E)`forgeVitest()`(中文(简体) )

执行 **没有** 设置 `forge()` 内 `vitest.config.ts`。Uniwind的维特适配器别名 `react-native` 在一个 vitest 解决 Flow- syntax 本地软件包的方法。 使用 `forgeVitest()` 相反:

```ts
import { defineConfig } from 'vitest/config';
import react from '@vitejs/plugin-react';
import { forgeVitest } from '@cdx-ui/web/vite';

export default defineConfig({
  plugins: [react(), forgeVitest()],
  test: {
    setupFiles: ['./src/__tests__/setup.ts'],
  },
});
```

```ts
// src/__tests__/setup.ts
import '@testing-library/jest-dom/vitest';
import { afterEach } from 'vitest';
import { cleanup } from '@testing-library/react';

afterEach(() => {
  cleanup();
});
```

在测试中将Forge UI 包入 `ForgeDesignProvider` (Dialog和其他覆盖需要其门户主机):

```tsx
import type { ReactElement } from 'react';
import { render } from '@testing-library/react';
import { SafeAreaProvider } from 'react-native-safe-area-context';
import { ForgeDesignProvider } from '@cdx-ui/components';

export function renderWithForgeProviders(ui: ReactElement) {
  return render(ui, {
    wrapper: ({ children }) => (
      <SafeAreaProvider>
        <ForgeDesignProvider config={{ toast: false }}>{children}</ForgeDesignProvider>
      </SafeAreaProvider>
    ),
  });
}
```

`forgeVitest()` 拥有 :

-   `react-native` → `react-native-web` (不是Uniwind的维特别名)
-   `@react-native-aria/*` • 无害环境管理 `lib/module` 条目
-   `@cdx-ui/*` 因此,Bob 无害环境管理目录的进口将得到解决
-   jsdom 单风、再动、手动、工作、安全区域、SVG、屏幕、底页、闪光列表、闪光日历和再动木马

这些替身 **导入时间边界**测试 `@cdx-ui/components` API;它们不验证生产CSS,动画计时,或本地手势. 见 `@cdx-ui/web/testing` 用于模拟包列表.

维系着消费者的生命 `examples/forge-ui-mui-vite`。 。 。 .

### `forgeVitest()` 选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `optimizerInclude` | `string[]` | `[]` | 额外维特依赖-优化包括条目 |

## 常见问题

### @cdx-ui/web 是什么？

在React web应用程序中使用Forge UI的Vite集成\.

### 如何安装 @cdx-ui/web？

在项目目录运行 npm install @cdx-ui/web，或使用 pnpm add / yarn add / bun add。

### @cdx-ui/web 支持 TypeScript 吗？

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

### @cdx-ui/web 支持 ESM 还是 CommonJS？

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

### @cdx-ui/web 可以商用吗？

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

### @cdx-ui/web 的下载量有多少？

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

### @cdx-ui/web 还在维护吗？

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

