@flare-engine/ui

中文文档
0.4.12发布于 2026/11/13Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 2415

UI kit — themed primitives, focus navigation, flex layout resolver

原始使用文档
文档目录6 节
  1. Entry points
  2. Install
  3. Usage
  4. Keyboard navigation
  5. Testing
  6. License

@flare-engine/ui

Skia-free UI kit for HUDs, menus, modals — Panel, Button, Label, List, Modal, HUDBar, ProgressBar, plus DialoguePanel, MainMenuKit higher-level components. ThemeProvider injects design tokens; FocusProvider + FocusManager drive focus navigation; createFocusKeyboardDriver wires arrows/Tab/Enter/Space onto the manager (gamepad driver pending); resolveLayout is a pure flex-like layout resolver. A shop list ships in @flare-engine/ui-shop, wired to @flare-engine/iap.

Entry points

  • . (default) — the whole kit: components, theme, focus, layout. Pulls in React Native at module scope.
  • ./focus — the RN-free focus core: createFocusManager + createFocusKeyboardDriver and their types (FocusManager, FocusManagerOptions, FocusNode, FocusKeyboardDriver, FocusKeyboardDriverOptions, FocusKeySource). No React or React Native import, so it is safe for bun test and Node harnesses. . re-exports the same names.

Install

bun add @flare-engine/ui

Peer deps: react, react-native.

Usage

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>
  );
}

Keyboard navigation

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

See API spec.

Testing

The . entry loads react-native at module scope, and the react-native entry file is Flow source that bun does not parse, so importing it under bun test needs four mock.module stubs (react, react/jsx-runtime, react/jsx-dev-runtime, react-native). ./focus needs none. The stubs, the load-order rules and a worked assertion: Testing ui and ui-shop under bun test.

License

Apache-2.0

版本与发布记录

@flare-engine/ui 共发布 17 个版本,首次发布于 2026/06/10;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.12latest2026/11/133 天前
0.4.112026/11/123 天前
0.4.102026/11/087 天前
0.4.82026/11/0610 天前
0.4.72026/11/0411 天前
0.4.62026/10/3115 天前

关于 @flare-engine/ui 的常见问题

@flare-engine/ui 是什么?

UI kit — themed primitives, focus navigation, flex layout resolver

如何安装 @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 和提交记录判断。