@ formaus/ 核心
JSON的无框架引擎形成定义:场态,验证,有条件的能见度,可重复组,多步导航和分路. 没有运行时间依赖性和UI. 部分 福伦豪斯。用于渲染、使用 @formhaus/react 或者说 @formhaus/vue。 。 。 .
安装
npm install @formhaus/core
要求节点22.12或更晚. 无害环境管理; require() 还行.
使用量
import { FormEngine, type FormDefinition } from '@formhaus/core';
const definition: FormDefinition = {
id: 'contact',
title: 'Contact Us',
submit: { label: 'Send' },
fields: [
{ key: 'name', type: 'text', label: 'Name', validation: { required: true } },
{ key: 'email', type: 'email', label: 'Email', validation: { required: true } },
],
};
const engine = new FormEngine(definition);
engine.setValue('name', 'Jane');
engine.validate();
// { email: 'This field is required' }
engine.setValue('email', '[email protected]');
engine.getSubmitValues();
// { name: 'Jane', email: '[email protected]' }
入境点
| 导入 | 目录 |
|---|---|
@formhaus/core | FormEngine, (中文(简体) ), checkDefinition(),类型 |
@formhaus/core/server | validateSubmission() 对无信任的有效载荷,也作为 server.iife.js |
@formhaus/core/cloud | 客户端 福尔豪斯云数字 : fetchForm(), (中文(简体) ), createSubmitter(), (中文(简体) ), createChallengeFrame() |
@formhaus/core/i18n | 信件和标签目录、 覆盖、 翻译密钥 |
@formhaus/core/fix | suggestFixes(), (中文(简体) ), applyFix(), (中文(简体) ), fixAll() |
@formhaus/core/fields | 自定义字段组件的助手 : fieldState(), (中文(简体) ), scaleView(), (中文(简体) ), fromDate(), (中文(简体) ), toDate() 和其他问题 |
@formhaus/core/research | 选入调查特征: research 用于随机选项顺序 |
@formhaus/core/schema | schemaValidate() 财务报告和审定财务报表 schemaParse() 用于 Zod, Valibot, ArkType 和其他标准 Schema 库 |
@formhaus/core/dirty | trackDirty() 未保存的更改 |
@formhaus/core/style.css | 可选基线样式 --fh-* 主题符号 |
@formhaus/core/schema.json | 定义中的JSON Schema |
@formhaus/core/internal 持有共享代码 @formhaus/react 财务报告和审定财务报表 @formhaus/vue。它不是一个公共API,并且没有模具保证:任何释放都可以改变它。 不要导入它.
网络
只有 /cloud 条目进行网络请求.
@formhaus/core/cloud电话https://api.formhaus.cc,或apiBase并装入一个挑战框https://formhaus.cc。 。 。 .- 其它每个条目都不提出网络请求.
特征
- 字段类型,验证规则,
show编号 :showAny条件、章节和 可重复组。见 字段 财务报告和审定财务报表 验证。 。 。 . - 多步骤形式 使用生命周期钩,合成步骤验证和 分支路线。 。 。 .
goToStep(id)打开一步 URL 路径:如果该步骤不能被打开,则表格打开之前可用的步骤并报告. - 服务器侧验证 根据同一定义.
- 形式活动: 通过
onFormEvent打电话start()获取form_viewed, (中文(简体) ),step_viewed, (中文(简体) ),field_shown, (中文(简体) ),form_submit_succeeded还有更多. - 外观订阅 :
subscribe(), (中文(简体) ),subscribeField(), (中文(简体) ),subscribeStructure()财务报告和审定财务报表subscribeValues()。 。 。 . - 翻译 通过目录和覆盖文件.
- 定义检查和JSON补丁 固定建议 结束
checkDefinition()财务报告和审定财务报表@formhaus/core/fix。 。 。 . - 福尔豪斯云:主机端点,提交,文件和bot检查.
FormhausForm内@formhaus/react/cloud财务报告和审定财务报表@formhaus/vue/cloud制作一个公布的表格. - 他们数字 :
import '@formhaus/core/style.css',然后覆盖--fh-*自定义属性。 一个黑暗的主题 与data-fh-theme="dark"。 。 。 . - Claude 代码技能和 MCP 服务器 生成和检查定义.
文档
许可证
麻省理工学院