# @cyclone-ui/vite 中文文档

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

版本：0\.0\.36
npm 元数据更新时间：2026-11-10T16:19:11.622Z
中文译文更新时间：2026-11-11T07:08:11.054Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40cyclone-ui/vite
原文对照：https://npmcn.com/package/%40cyclone-ui/vite/?lang=original
项目主页：https://github.com/storm-software/cyclone-ui#readme
源码仓库：https://github.com/storm-software/cyclone-ui

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

- 包体积（解压后）：25.6 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：vite ^8\.3\.6，react-native-web 0\.19\.12，@cyclone-ui/tokens 0\.3\.54
- 首次发布：2026-10-24T11:16:43.763Z
- 最新版本发布：2026-11-10T16:19:09.708Z
- 近 30 天下载量：5975（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

一个Vite插件,在Vite应用中设置了Tamagui和Cypress UI组件.

## 安装

```sh
npm install @cyclone-ui/vite
```

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

## README

# 旋风 UI - Vite 插件

设置 Vite 插件 [塔马吉](https://tamagui.dev/) 和气旋UI vite 应用程序中的组件。 包起来 [`@tamagui/vite-plugin`](https://tamagui.dev/docs/guides/vite) 与旋风相伴 UI默认.

## 快速特性

-   别名 `react-native` 改为 `react-native-web` 并决心 `.web.*` 首先的文件
-   预捆绑和拆卸共享回放背景的 Tamagui 包
-   运行 Tamagui 优化编译器, 并使用来自 Circle UI 配置 `@cyclone-ui/tokens`,或用你自己的设计符号建造的
-   定义 `process.env.TAMAGUI_TARGET`,该“旋风”组件读取 只使用网络样式

## 安装

使用 [小时](http://pnpm.io/)数字 :

```bash
pnpm add -D @cyclone-ui/vite
pnpm add @cyclone-ui/state @cyclone-ui/tokens @tamagui/core jotai react-native-web
```

插件只是无害环境管理,所以项目 `package.json` 需求 `"type": "module"` (或 a 个) `vite.config.mts` 存档).

## 使用量

将插件添加到 `vite.config.ts`数字 :

```ts
import { cycloneUI } from "@cyclone-ui/vite";
import react from "@vitejs/plugin-react";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [react(), cycloneUI()]
});
```

然后将应用包入"旋风"主题提供者:

```tsx
import { ThemeProvider } from "@cyclone-ui/state/theme";
import { config } from "@cyclone-ui/tokens/tamagui";

createRoot(document.getElementById("root")!).render(
  <ThemeProvider config={config} disableInjectCSS={false}>
    <App />
  </ThemeProvider>
);
```

### 选项

`cycloneUI()` 接受每个 [`@tamagui/vite-plugin` 选项](https://tamagui.dev/docs/guides/vite)编辑 默认为:

| 选项 | 默认 |
| --- | --- |
| `config` | `"@cyclone-ui/tokens/tamagui"` |
| `components` | `["@tamagui/core"]` |

过 `disableExtraction: true` 以保留运行时的样式(例如,在运行时) 调试). A 类 `tamagui.build.ts` 工程根中的文件覆盖这些 选项.

### 自定义设计符号

过 `tokens` 以您自己的设计符号构建 Tamagui 配置 气旋UI默认值。 使用 DTCG 令牌对象,或令牌文件路径或 相对于 Vite 根的阴影 :

```ts
export default defineConfig({
  plugins: [react(), cycloneUI({ tokens: "tokens/**/*.json" })]
});
```

有主题名的文件( E)`light.tokens.json`, (中文(简体) ), `dark.tokens.json`变成 页:1 `light` 财务报告和审定财务报表 `dark` 主题。 符号通过相同的预处理器和 生成器为 `@cyclone-ui/tokens`,则a `razorwind.config.ts` 在项目中 仍然适用(例如其字体).

配置是写给 `.cyclone-ui/tamagui.config.ts` (编) `.cyclone-ui` 改为 `.gitignore`当 Vite 开始并替换时 `@cyclone-ui/tokens/tamagui` 用于编译器和每个导入,所以 `ThemeProvider` 以上设置 同样的。 更改符后重新启动 Vite .

## 发展

```bash
pnpm nx run vite:build
```

## 常见问题

### @cyclone-ui/vite 是什么？

一个Vite插件,在Vite应用中设置了Tamagui和Cypress UI组件\.

### 如何安装 @cyclone-ui/vite？

在项目目录运行 npm install @cyclone-ui/vite，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vite（^8\.3\.6）、react-native-web（0\.19\.12）、@cyclone-ui/tokens（0\.3\.54）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cyclone-ui/vite 支持 TypeScript 吗？

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

### @cyclone-ui/vite 支持 ESM 还是 CommonJS？

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

### @cyclone-ui/vite 可以商用吗？

@cyclone-ui/vite 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @cyclone-ui/vite 的下载量有多少？

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

### @cyclone-ui/vite 还在维护吗？

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