yakin

FormRender

> 一站式中后台表单解决方案

官网

FormRender 1.0 是下一代的 React.js 表单解决方案。项目从内核级别进行了重写，为了能切实承接日益复杂的表单场景需求。我们的目标是以强大的扩展能力对表单场景 100%的覆盖支持，同时保持开发者能快速上手，并以表单编辑器、插件、自定义组件等一系列周边产品带来极致的开发体验。在开发 1.0 的道路上，我们做了一系列的取舍，详见0.x - 1.0 迁移文档

安装

FormRender 依赖 ant design，单独使用不要忘记同时安装 antd

``shell
npm i antd --save
`

使用

最简使用 demo：

`jsx
import React from 'react';
import { Button } from 'antd';
import FormRender, { connectForm } from 'yakin';

const schema = {
type: 'object',
properties: {
input1: {
title: '简单输入框',
type: 'string',
required: true,
},
select1: {
title: '单选',
type: 'string',
enum: ['a', 'b', 'c'],
enumNames: ['早', '中', '晚'],
},
},
};

class Demo extends React.Component {
render() {
const { form } = this.props;
return (


export default connectForm(Demo);
`

对于函数组件，FormRender 提供了 useForm hooks, 书写更为灵活

`jsx
import React from 'react';
import { Button } from 'antd';
import FormRender, { useForm } from 'yakin';

const schema = {
type: 'object',
properties: {
input1: {
title: '简单输入框',
type: 'string',
required: true,
},
select1: {
title: '单选',
type: 'string',
enum: ['a', 'b', 'c'],
enumNames: ['早', '中', '晚'],
},
},
};

const Demo = () => {
const form = useForm();
return (


export default Demo;
`

从 demo 中我们不难发现 FormRender 的一些设计：

1. 以 schema 来描述表单展示，提交方式与 antd v4 的方式类似
2. schema 以国际标准的 JSON schema 为基础，同时能够方便使用任何 antd 的 props
3. 通过 bind 字段，我们允许数据的双向绑定，数据展示和真实提交的数据可以根据开发需求不同（例如从服务端接口拿到不规则数据时，也能直接使用）
4. 可以通过displayType,labelWidth等字段轻易修改展示

组件 Props

`js
import Form, { useForm, connectForm } from 'yakin';
`

$3

| 参数 | 描述 | 类型 | 是否必填 | 默认值 |
| ---------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------- | -------- | -------- |
| id | 表单的 id，一般用于标识一个表单的语义化名称 | string/number | 否 | |
| schema | 描述表单的 schema，详见 | object | 是 | |
| form | useForm创建的表单实例，与 Form 一对一绑定 | FormInstance | 是 | |
| onFinish | 提交后的回调，执行 form.submit() 后触发 | (data, errors: Error[]) => void | 否 | () => {} |
| beforeFinish | 在 onFinish 前触发，一般用于外部校验逻辑的回填，入参是个对象，便于扩展 | ({ data, errors, schema, ...rest }) => Error[] 或 Promise | 否 | () => {} |
| onMount | 表单首次加载时触发，详见生命周期 | () => void | 否 | () => {} |
| displayType | 表单元素与 label 同行 or 分两行展示, inline 则整个展示自然顺排 | string('column' / 'row' / 'inline') | 否 | 'column' |
| labelAlign | label 标签的文本对齐方式 | string('left' / 'right') | 否 | 'right' |
| colon | 表示是否显示 label 后面的冒号 | boolean | 否 | true |
| widgets | 自定义组件，当内置组件无法满足时使用 | object | 否 | {} |
| watch | 类似于 vue 的 watch 的用法，详见表单监听 & 回调 | object | 否 | {} |
| removeHiddenData | 提交数据的时候是否去掉已经被隐藏的元素的数据，默认不隐藏 | boolean | 否 | true |
| debug | 开启 debug 模式，时时显示表单内部状态，开发的时候强烈建议打开 | boolean | 否 | false |
| readOnly | 只读模式，一般用于预览展示，全文 text 展示 | boolean | 否 | false |

注 1：

$3

| 参数 | 描述 | 类型 | 默认值 |
| -------------------- | ---------------------------------------------------------------- | ------------------- | ------ |
| className (v.1.6.12) | 顶层 className | string | '' |
| style (v.1.6.12) | 顶层 style | object | {} |
| column | 一行展示多少列 | number | 1 |
| mapping | schema 与组件的映射关系表，当内置的表不满足时使用 | object | {} |
| disabled | 禁用模式，全部表单元素禁用 | boolean | false |
| debugCss | 用于 css 问题的调整，显示 css 布局提示线 | boolean | false |
| locale | 展示语言，目前只支持中文、英文 | string('cn'/'en') | 'cn' |
| configProvider | antd 的 configProvider，配置透传 | object | - |
| allCollapsed | 对象组件是否默认折叠（全局） | boolean | false |
| debounceInput | 是否开启输入时使用快照模式。仅建议在表单巨大且表达式非常多时开启 | boolean | false |
| validateMessages | 修改默认的校验提示信息。详见下 | object | {} |

#### validateMessages

Form 为验证提供了默认的错误提示信息，你可以通过配置 validateMessages 属性，修改对应的提示模板。一种常见的使用方式，是配置国际化提示信息：

`js
const validateMessages = {
required: '${title}是必选字段',
// ...
};