form-render

FormRender

通过 JSON Schema 生成标准 Form，常用于自定义搭建配置界面生成

了解

• 文档官网
• Playground / Code Sandbox
• 常见场景
• Proptypes to Json Schema

优势

• 支持 Ant Design 和 Fusion Design 主流的视觉主题
• 使用 JSON Schema 标准协议描述表单配置，并搭配丰富类型且可扩展的组件
• 支持 1 排 N、横纵排、支持对象无限嵌套、自定义正则校验、自定义样式组件、列表拖拽等特性
• 已在淘宝、天猫、飞猪、亚博科技、安全智能、新零售行业工作台、人工智能实验室、安全智能部门等多 BU 多场景使用，简单使用同时支持复杂场景使用
• 使用上有详细文档，维护上有专人支持

安装

npm i form-render -S

快速使用

import React from "react";
import ReactDOM from "react-dom";
// 使用 Ant Design 体系
import FormRender from "form-render/lib/antd";

// 使用 Fusion Design 体系
// import "@alifd/next/dist/next.min.css";
// import FormRender from "form-render/lib/fusion";

// propsSchema 使用标准的 JSON Schema 来描述表单结构
const propSchema = {
  type: "object",
  properties: {
    dateDemo: {
      title: "时间",
      type: "string"
    }
  }
};

// uiSchema 可以增强展示类型的丰富性，如时间组件
const uiSchema = {
  dateDemo: {
    "ui:widget": "date"
  }
};

class App extends React.Component {
  constructor() {
    super();
    this.state = {
      formData: {}
    };
  }

  // 数据变化回调
  onChange = value => {
    this.setState({
      formData: value
    });
  };

  // 数据格式校验回调
  onValidate = list => {
    console.log(list);
  };

  render() {
    const { formData } = this.state;
    return (
      <FormRender
        propsSchema={propSchema}
        uiSchema={uiSchema}
        formData={formData}
        onChange={this.onChange}
        onValidate={this.onValidate}
      />
    );
  }
}

const rootElement = document.getElementById("root");
ReactDOM.render(<App />, rootElement);

API

Prop	Type	Required	Default	Description
name	String	Y	$form	表单的名称
propsSchema	Object	Y	{}	表单属性配置 json
uiSchema	Object	N	{}	表单 UI 配置 json
formData	Object	N	{}	配置数据
onChange	Function	Y	()=>{}	数据更改回调函数
onValidate	Function	N	()=>{}	表单输入校验回调
displayType	String	N	column	设置表单横向排列或者纵向排序column/ row

注 1： 设置表单 displayType 为 row 时候，请设置 showDescIcon 为 true，隐藏说明，效果会更好
注 2： onChange 方法会用于初始化表单 data，如果不写会造成没有初始值的表单元素无法渲染（出现不报错也不显示的情况）
注 3： FormRender 默认布局会占满它的父级元素，建议用一个div包裹 FormRender 用于表单布局样式调整

不常用 API

Prop	Type	Required	Default	Description
column	Number	1	N	整体布局 1 排 N，局部的 1 排 N 一般使用ui:width
showValidate	Boolean	N	true	是否展示校验信息
showDescIcon	Boolean	N	false	是否将文字形式说明显示成描述 tooltip 形式
widgets	Object	N	{}	自定义组件
mapping	Object	N	{}	用于修改默认组件映射表
FieldUI	Component	N	内置组件	用于自定义整个元素的样式（标签、结构等）

原理

FormRender 底层引擎用原生 JS 来实现，通过解析 JSON Schema 配置，并支持渲染原生的 HTML 表单，通过 UiSchema 来配置 Widget 组件，在此基础上处理好上层 Ant Design 或 Fusion 组件 Widget 和 Input Format 的对应关系，最后还可以做到无缝接入其他组件体系的好处

调试

> git clone https://github.com/alibaba/form-render.git
> npm i
> npm run start

支持

• 在公司或个人项目中使用 FormRender，关注 Changelog

• 如果你觉得 FormRender 还不错，可以通过 Star 来表示你的喜欢

• 加入钉钉聊天群帮忙解答使用问题

  

贡献

想贡献代码、解 BUG 或者提高文档可读性？非常欢迎一起参与进来，在提交 MR 前阅读一下 Contributing Guide

感谢给 FormRender 贡献代码的你们！

协议

• 遵循 MIT 协议
• 请自由地享受和参与开源