# @flare-engine/ui 中文文档

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

版本：0\.4\.12
npm 元数据更新时间：2026-11-12T19:46:02.329Z
中文译文更新时间：2026-11-14T21:42:59.172Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：187 kB，24 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：react \>=19\.0\.0，react-native \>=0\.79\.0
- 首次发布：2026-06-09T16:19:46.646Z
- 最新版本发布：2026-11-12T19:46:01.916Z
- 近 30 天下载量：2415（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

UI 工具包——主题原始,焦点导航,弹性布局解析器

## 安装

```sh
npm install @flare-engine/ui
```

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

## README

# @flare-engine/ui (英语)

用于HUD,菜单,模式的无线UI工具箱—— `Panel`, (中文(简体) ), `Button`, (中文(简体) ), `Label`, (中文(简体) ), `List`, (中文(简体) ), `Modal`, (中文(简体) ), `HUDBar`, (中文(简体) ), `ProgressBar`附加时 `DialoguePanel`, (中文(简体) ), `MainMenuKit` 高级组件. `ThemeProvider` 注入设计标志; `FocusProvider` + 键 `FocusManager` 驱动焦点导航; `createFocusKeyboardDriver` 将线箭头/Tab/Enter/Space接入管理器(游戏板驱动程序待决); `resolveLayout` 是一个纯弹性的布局解析器。 一个商店列表的船只在 `@flare-engine/ui-shop`,接线到 `@flare-engine/iap`。 。 。 .

## 入境点

-   **`.` (默认)** ——全包:组件,主题,焦点,布局. 在模块范围进行原始反应.
-   **`./focus`** ——无RN焦点核心: `createFocusManager` + 键 `createFocusKeyboardDriver` 及其种类(续)`FocusManager`, (中文(简体) ), `FocusManagerOptions`, (中文(简体) ), `FocusNode`, (中文(简体) ), `FocusKeyboardDriver`, (中文(简体) ), `FocusKeyboardDriverOptions`, (中文(简体) ), `FocusKeySource`。没有反应或反应原生导入,因此安全 `bun test` 和节点牵引. `.` 再出口相同名称.

## 安装

```sh
bun add @flare-engine/ui
```

端点 : `react`, (中文(简体) ), `react-native`。 。 。 .

## 使用量

```tsx
import { ThemeProvider, FocusProvider, Panel, Button, Label, darkTheme } from '@flare-engine/ui';

function PauseMenu({ onResume }: { onResume: () => void }) {
  return (
    <ThemeProvider theme={darkTheme}>
      <FocusProvider>
        <Panel variant="elevated">
          <Label variant="lg">Pause</Label>
          <Button variant="primary" label="Resume" onPress={onResume} />
        </Panel>
      </FocusProvider>
    </ThemeProvider>
  );
}
```

## 键盘导航

```ts
import { createFocusManager, createFocusKeyboardDriver, type FocusKeySource } from '@flare-engine/ui/focus';
// keys is any { wasPressed(code: string): boolean } — createKeyboard() from
// @flare-engine/input is structurally assignable, no hard dependency required.
declare const keys: FocusKeySource;
const manager = createFocusManager();
const driver = createFocusKeyboardDriver(manager, keys);
// per-frame game loop:
driver.update(); // ArrowDown/ArrowRight/Tab → next, ArrowUp/ArrowLeft → prev, Enter/Space → activate
```

见 [API 规格](https://github.com/grzott/flare-engine/blob/main/docs/design/api-specs.md#flare-engineui--6kb-gzip-target)。 。 。 .

## 测试

这个 `.` 输入负载 `react-native` 模块范围,以及 `react-native` 条目文件是 Flow 源代码不解析, 因此导入到下面 `bun test` 需求 4 `mock.module` 支点( 秒)`react`, (中文(简体) ), `react/jsx-runtime`, (中文(简体) ), `react/jsx-dev-runtime`, (中文(简体) ), `react-native`) (中文(简体) ). `./focus` 没有。 积分 负载订单规则 以及一个有效的断言: [在包子测试下测试ui和ui-shop](https://github.com/grzott/flare-engine/blob/main/docs/recipes/testing-ui-under-bun.md)。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @flare-engine/ui 是什么？

UI 工具包——主题原始,焦点导航,弹性布局解析器

### 如何安装 @flare-engine/ui？

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

### @flare-engine/ui 支持 TypeScript 吗？

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

### @flare-engine/ui 支持 ESM 还是 CommonJS？

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

### @flare-engine/ui 需要什么版本的 Node\.js？

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

### @flare-engine/ui 可以商用吗？

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

### @flare-engine/ui 的下载量有多少？

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

### @flare-engine/ui 还在维护吗？

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