@golemui/gui-schemas

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

JSON Schemas for GolemUI会形成定义,因此用JSON所写的动态形式会得到编辑器的完成和验证. 开源 (MIT).

中文使用文档
文档目录6 节
  1. 安装
  2. 版式
  3. 用 Ajv 验证
  4. 将 JSON Schema 转换为 gui 格式
  5. 文档
  6. 许可证

@golemui/gui-schemas (法语)

戈莱姆UI:来自JSON的动态形式用于反应,Angular,Vue,Lit和香草JS.

安装

npm install @golemui/gui-schemas

版式

schemas/
  form.schema.json           form envelope (generated)
  widgets.schema.json        widget union + knownWidgetTypes enum (generated)
  layout-widget.schema.json  layout widget union (generated)
  validators.schema.json     the gui validator set (handwritten)
  ranges.schema.json         shared date and time range defs (handwritten)
  components/*.schema.json   per-widget schemas (handwritten)
  core/*.schema.json         vendored copy of the @golemui/schemas core file (generated)

每个文件下 schemas/ 作为原始资产可以达到,例如 @golemui/gui-schemas/schemas/components/textinput.schema.json软件包 拥有一个 JavaScript 输入点,以导出与对象相同的文件.

生成的文件来自部件列表 (单位:千美元)src/lib/widget-manifest.ts) (中文(简体) ). 不编辑它们, 运行 npm run generate:schemas 在更改表单或表单后 @golemui/schemas 核心来源。 CI 失败 当生成的文件为 stale.

共享 common.schema.json 移动到 @golemui/schemas 软件包和是 这里卖的 schemas/core/. 进口: @golemui/gui-schemas/schemas/common.schema.json 必须切换到 schemas/core/common.schema.json。供应商副本与核心相同 来源除 $id,它重置到此树上 (单位:千美元)https://golemui.com/schemas/gui/core/common.schema.json因此,它符合 找回兄弟间决心的URI. validators.schema.json 留在原点 页:1 schemas/ root 并属于此软件包: 校验词汇为 具体实施,因此不属于核心层,以及 $id 实值 现在 https://golemui.com/schemas/gui/validators.schema.json软件包 入站出口名称(commonSchema, (中文(简体) ), validatorsSchema和每个 组件导出)不变,但 $id 价值和价值 $ref 版式 没有.

这些 $id 值是标识符,而不是下载 URL。 相配树下 https://golemui.com/schemas/ 尚未发布,所以没有参考 他们今天.

用 Ajv 验证

每个已运出的文件都声明 $id 他们的兄弟姐妹们提到, 所以注册 需要的只是这些文件。 组件参考像 ../core/common.schema.json 解决卖主核心副本的 $id。 。 。 .

import Ajv2020 from 'ajv/dist/2020';
import {
  commonSchema,
  rangesSchema,
  textinputSchema,
  validatorsSchema,
} from '@golemui/gui-schemas';

const ajv = new Ajv2020();
ajv.addSchema(commonSchema);
ajv.addSchema(validatorsSchema);
ajv.addSchema(rangesSchema);
const validate = ajv.compile(textinputSchema);

生下来的 schemas/ 文件的处理方式相同: 逐一注册 $id 解决整个树, 不包括来自此软件包的 JavaScript . 核心内容 common.schema.json 联 合 国 @golemui/schemas 自己留着吧 $id,所以两者 包可以装入一个 Ajv 实例.

将 JSON Schema 转换为 gui 格式

@golemui/gui-schemas/json-schema 出口 guiPreset,用于 页:1 fromJsonSchema 转换器 @golemui/schemas/json-schema转换器 及其定制层在 @golemui/schemas 读取。 这个 同一函数也导出为 preset,名称 npx @golemui/schemas convert --preset @golemui/gui-schemas/json-schema 负载.

import { fromJsonSchema } from '@golemui/schemas/json-schema';
import { guiPreset } from '@golemui/gui-schemas/json-schema';

const { formDefinition, diagnostics } = fromJsonSchema(schema, {
  preset: guiPreset({ submitLabel: 'Save', enumThresholds: { radio: 3 } }),
});

预设选择这些部件 :

  • enum,或 oneOf编号 :anyOf 联 合 国 const数字 : radiogroup 最多 enumThresholds.radio 选项(默认情况下为0), select 最多 enumThresholds.select (6个默认), dropdown 见上文.
  • 字符串 : dateInput, (中文(简体) ), dateTimePicker 财务报告和审定财务报表 timeInput 以 format, (中文(简体) ), password 页:1 format: password, (中文(简体) ), writeOnly 或者一个秘密的名字, markdown 页:1 contentMediaType: text/markdown, (中文(简体) ), textarea 从 maxLength 200美元,以及 textinput 否则。 A 类 const 是只读输入.
  • number 财务报告和审定财务报表 integer数字 : number。 。 。 . boolean数字 : checkbox。 。 。 .
  • 数组 : repeater 对象, multiList 或者说 multiDropdown 选择, tags 用于其他值,以及一行输入来表示 tuple.
  • 对象: a flex 栏. objectTitle: 'markdownText' 或者说 'alert' 显示 对象标题高于其属性.

title 是标签, description 提示, examples[0] 占地者, readOnly 输入只读,并且 default 是默认值. 限制变成了gui验证符。 日期时间部件写入本地时间 减去世界协调时 local-datetime 诊断指出.

该软件包构建了ES和CommonJS模块. require('@golemui/gui-schemas') 负载 index.cjs,替换前一个 index.umd.cjs。 。 。 .

文档

许可证

麻省理工学院

版本与发布记录

@golemui/gui-schemas 共发布 60 个版本,首次发布于 2026/05/27;过去 12 个月发布了 60 个版本。最新版本附带 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/gui-schemas 的常见问题

@golemui/gui-schemas 是什么?

JSON Schemas for GolemUI会形成定义,因此用JSON所写的动态形式会得到编辑器的完成和验证. 开源 (MIT).

如何安装 @golemui/gui-schemas?

在项目目录运行 npm install @golemui/gui-schemas,或使用 pnpm add / yarn add / bun add。

@golemui/gui-schemas 支持 TypeScript 吗?

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

@golemui/gui-schemas 支持 ESM 还是 CommonJS?

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

@golemui/gui-schemas 可以商用吗?

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

@golemui/gui-schemas 的下载量有多少?

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

@golemui/gui-schemas 还在维护吗?

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