@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页:1format: password, (中文(简体) ),writeOnly或者一个秘密的名字,markdown页:1contentMediaType: text/markdown, (中文(简体) ),textarea从maxLength200美元,以及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。 。 。 .
文档
- 网站: https://golemui.com (中文(简体) )
- 仓库 : https://github.com/golemui/golemui 互联网档案馆的存檔,存档日期2013-12-22
- 资料来源: https://github.com/golemui/golemui/tree/main/libs/gui/schemas 页面存档备份,存于互联网档案馆
- 问题: https://github.com/golemui/golemui/ 发售
许可证
麻省理工学院