@golemui/react

中文文档
2.2.1发布于 2026/11/16MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2821

React bindings of the GolemUI forms engine, for building widget sets. For dynamic forms in React, install @golemui/gui-react. Open source (MIT).

原始使用文档
文档目录5 节
  1. Install
  2. Rendering without a DOM
  3. Setting the form health
  4. Documentation
  5. License

@golemui/react

GolemUI: dynamic forms from JSON for React, Angular, Vue, Lit and vanilla JS.

Install

npm install @golemui/react

Rendering without a DOM

By default, a form renders its widget tree inside a div.gui-form and a form element. A React renderer without a DOM, for example a terminal or a native renderer, cannot render these elements. Set headless to render the widget tree only:

import { createFormComponent } from '@golemui/react';

export const NativeForm = createFormComponent(nativeWidgetSet, {
  headless: true,
  widgetErrorFallback: (error, widget) => (
    <Text>
      {widget.type} failed: {error.message}
    </Text>
  ),
  formHealthBoundary: ({ health, children }) => (
    <>
      {health.status === 'errored' && <Text>{health.message}</Text>}
      {children}
    </>
  ),
});

In headless mode:

  • The default error UI is made of DOM elements, so it renders nothing. The errors are still logged to the console. Pass widgetErrorFallback and formHealthBoundary to show them.
  • There is no form element to submit. A submit button calls onSubmit from useActionWidget after onClick. onSubmit does nothing when the action is not a submit action.
  • autocomplete has no effect.

react-dom is not a peer dependency of this package. Install it only when you render to the DOM.

Setting the form health

The form ref has setHealth, next to setData and setMeta. It reports an error the form cannot see, for example a server that cannot be reached. An errored health freezes the form and shows the formHealthBoundary until a call with { status: 'ok' } clears it. The form sends formHealth for both calls. Codes below 1000 belong to the core.

import { useRef } from 'react';
import type { FormComponentHandle } from '@golemui/react';

const form = useRef<FormComponentHandle>(null);

<NativeForm ref={form} config={{ formDef }} />;

form.current?.setHealth({
  status: 'errored',
  code: 10_001,
  message: 'The server cannot be reached',
});
// Later, when the server is back:
form.current?.setHealth({ status: 'ok' });

Documentation

License

MIT

版本与发布记录

@golemui/react 共发布 112 个版本,首次发布于 2026/03/02;过去 12 个月发布了 106 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.2.1latest2026/11/16今天
2.2.1-rc.0next2026/11/16今天
2.2.02026/11/133 天前
2.2.0-rc.22026/11/133 天前
2.2.0-rc.12026/11/134 天前
2.2.0-rc.02026/11/124 天前

关于 @golemui/react 的常见问题

@golemui/react 是什么?

React bindings of the GolemUI forms engine, for building widget sets. For dynamic forms in React, install @golemui/gui-react. Open source (MIT).

如何安装 @golemui/react?

在项目目录运行 npm install @golemui/react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18.0.0)、@golemui/core(2.2.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@golemui/react 支持 TypeScript 吗?

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

@golemui/react 支持 ESM 还是 CommonJS?

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

@golemui/react 可以商用吗?

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

@golemui/react 的下载量有多少?

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

@golemui/react 还在维护吗?

最新版本 2.2.1 发布于 2026/11/16(今天);至今共发布 112 个版本,其中过去 12 个月发布了 106 个;首次发布于 2026/03/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。