查看原文
其他

【开源】阿里可跨组件体系的表单配置生成方案:form-render

汤威 前端早读课 2019-11-21

FormRender 是一个通过 JSON Schema 生成标准 Form 的渲染引擎,常用于自定义搭建配置界面生成

比如你有想通过一定标准约束自动生成表单配置界面,类似于搭建配置表单界面这种场景,就可以考虑 FormRender,比如这些类型场景:https://alibaba.github.io/form-render/#/docs/used

在内部实践一年后,也有十多个BU在使用,为了让外部也可以用上,我们于今年10月份对它进行的开源到alibaba/form-render🏄🏄🏄:https://github.com/alibaba/form-render

为什么要做 FormRender ?

中后台 50%的场景和表单有关,并在可灵活配置上要求很高,特别是搭建表单配置场景,通过下发 JSON 配置来生成表单视图的方式可以提高效率

调研过集团内外相关方案,可支持 Antd 或者 Fusion 体系、满足 JSON Schema 协议、配置简单即可使用的方案暂无找到

思路

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

特点

  • 支持 Ant Design 和 Fusion Design 主流的视觉主题

  • 使用 JSON Schema 标准协议描述表单配置,并搭配丰富类型且可扩展的组件

  • 支持 1 排 N、支持对象无限嵌套、自定义正则校验、自定义样式组件、列表拖拽等特性

  • 已在飞猪、亚博科技、安全智能、淘宝、新零售行业工作台、人工智能实验室、天猫等多BU多场景使用,可支持复杂场景使用

  • 使用上有详细文档,维护上有专人支持

如何使用

  1. // 安装

  2. npm i form-render -S

  1. import React from "react";

  2. import ReactDOM from "react-dom";

  3. // 使用 Ant Design 体系

  4. import FormRender from "form-render/lib/antd";


  5. // 使用 Fusion Design 体系

  6. // import "@alifd/next/dist/next.min.css";

  7. // import FormRender from "form-render/lib/fusion";


  8. // propsSchema 使用标准的 JSON Schema 来描述表单结构

  9. const propSchema = {

  10. type: "object",

  11. properties: {

  12. dateDemo: {

  13. title: "时间",

  14. type: "string"

  15. }

  16. }

  17. };


  18. // uiSchema 可以增强展示类型的丰富性,如时间组件

  19. const uiSchema = {

  20. dateDemo: {

  21. "ui:widget": "date"

  22. }

  23. };


  24. class App extends React.Component {

  25. constructor() {

  26. super();

  27. this.state = {

  28. formData: {}

  29. };

  30. }


  31. // 数据变化回调

  32. onChange = value => {

  33. this.setState({

  34. formData: value

  35. });

  36. };


  37. // 数据格式校验回调

  38. onValidate = list => {

  39. console.log(list);

  40. };


  41. render() {

  42. const { formData } = this.state;

  43. return (

  44. <FormRender

  45. propsSchema={propSchema}

  46. uiSchema={uiSchema}

  47. formData={formData}

  48. onChange={this.onChange}

  49. onValidate={this.onValidate}

  50. />

  51. );

  52. }

  53. }


  54. const rootElement = document.getElementById("root");

  55. ReactDOM.render(<App />, rootElement);

文档如下

  • 文档官网:https://alibaba.github.io/form-render/

  • Demo探索:https://alibaba.github.io/form-render/docs/demo/index.html

  • Code Sandbox:https://codesandbox.io/s/form-renderjichudemo-8k1l5?fontsize=14

  • 常见场景:https://alibaba.github.io/form-render/#/docs/used

  • Proptypes to Json Schema:https://alibaba.github.io/form-render/#/docs/proptypes


“Form Render 开源社区”群的钉钉群号:23185578


项目地址:https://github.com/alibaba/form-render


为你推荐


【第1594期】从表单抽象到表单中台


【第1569期】配置化页面渲染系统设计和实践


【第1767期】微信小程序工程化之持续集成方案

    您可能也对以下帖子感兴趣

    文章有问题?点此查看未经处理的缓存