form-presenter

v3.0.16

Published

2 years ago

FormPresenter

Downloads

0High
0Medium
0Low

FormPresenter 使用指南

简介

FormPresenter 是一个根据数据模型生成表单的对象（MDD）的库

使用场景

所有表单场景

run demo

git clone https://github.com/zlx362211854/form-presenter.git

cd form-presenter

npm i

npm run dev

安装

npm i form-presenter

使用方法

实例化 presenter

import FormPresenter from "form-presenter";
const presenter = new FormPresenter({}); // 实例化

实例化时设置表单数据模型

const presenter = new FormPresenter({
  formItems: [
    {
      label: "姓名",
      key: "name",
      uiType: "input",
      rules: [
        {
          required: true,
          message: "请输入姓名",
        },
      ],
    },
  ],
});
// 设置一个name字段

设置表单的初始值

const presenter = new FormPresenter({
  formItems: [
    {
    label: '姓名',
    key: 'name',
    uiType: 'input',
    rules: [
      {
        required: true,
        message: '请输入姓名',
      },
    ],
  },
  ],
  initFormValues: {
    name: 'zlx' // 设置name的初始值为zlx
  }
})
// 在一些情景下，我们需要初始化presenter实例了以后再设置表单的初始值，这时可以在表单组件实例中将初始值作为props传入
const presenter = new FormPresenter({
  formItems: [
    {
    label: '姓名',
    key: 'name',
    uiType: 'input', // 设置字段的ui组件为input
    rules: [
      {
        required: true,
        message: '请输入姓名',
      },
    ],
  },
  ],
  initFormValues: {} // 实例化时不设置初始值，而是在表单组件中设置
})
// 获取表单组件实例
const FormComponent = presenter.getFormComponent()
// 设置初始值
<FormComponent
	initFormValues={{
     name: 'zlx' // 设置name的初始值为zlx
    }}
/>

获取表单组件实例并渲染

// 获取表单组件实例
const FormComponent = presenter.getFormComponent()
// 渲染实例
<FormComponent {...formComponentProps}/>

代码示例

import FormPresenter from "./FormPresenter";
import { IFormItem } from "./declare";
const info: IFormItem[] = [
  {
    label: "姓名",
    key: "name",
    uiType: "input", // 设置字段的ui组件为input
    rules: [
      {
        required: true,
        message: "请输入姓名",
      },
    ],
  },
];
export default class Test extends React.Component {
  private presenter: FormPresenter;
  constructor(props) {
    super(props);
    this.presenter = new FormPresenter({
      formItems: info,
      initFormValues: {},
    });
  }
  render() {
    const FormComponent = this.presenter.getFormComponent();
    const formComponentProps = {
      initFormValues: {
        name: "zlx",
      },
    };
    return (
      <div title={"测试"}>
        <FormComponent {...formComponentProps} />
      </div>
    );
  }
}

生成组件效果：

某些情景下，我们需要在多个表单字段之间联动，如：姓名输入为“杨超越”时，年龄自动变为 18，我们可以通过监听 onValuesChange 来实现

const info: IFormItem[] = [
  {
    label: '姓名',
    key: 'name',
    uiType: 'input', // 设置字段的ui组件为input
    rules: [
      {
        required: true,
        message: '请输入姓名',
      },
    ],
  },
  {
    label: '年龄',
    key: 'age',
    uiType: 'input',
    rules: [
      {
        required: true,
        message: '请输入年龄',
      },
    ],
  },
]
// ...
constructor(props) {
    super(props)
    this.presenter = new FormPresenter({
      formItems: info,
      initFormValues: {},
      onValuesChange: ({form}, changedvalues, allValues) => {
        // reaction
        if (changedvalues && changedvalues.name) {
          if (changedvalues.name === "杨超越") {
            form.setFields({
              age: {
                value: 18
              },
            })
          }
        }
      },
    })
  }

某些情景下，presenter 内置的表单元素并不能满足个性化需求，这时可以通过自定义渲染来动态添加自定义表单组件

const info: IFormItem[] = [
  {
    label: "姓名",
    key: "name",
    uiType: "input", // 设置字段的ui组件为input
    rules: [
      {
        required: true,
        message: "请输入姓名",
      },
    ],
  },
];
export default class Test extends React.Component {
  private presenter: FormPresenter;
  constructor(props) {
    super(props);
    this.presenter = new FormPresenter({
      formItems: info,
      initFormValues: {},
    });
  }
  add = () => {
    this.presenter.addFormItem({
      label: "描述",
      key: "desc",
      uiType: "custom", // 添加类型为自定义组件（也可以添加内置组件）
      rules: [
        {
          required: false,
          message: "",
        },
      ],
      render: this.renderDom,
    });
  };
  renderDom = React.forwardRef((props, ref) => {
    return <span ref={ref}>这是添加的自定义组件</span>;
  });
  render() {
    const FormComponent = this.presenter.getFormComponent();
    const formComponentProps = {
      initFormValues: {
        name: "zlx",
      },
    };
    return (
      <div title={"测试"}>
        <FormComponent {...formComponentProps} />
        <Button onClick={() => this.add()}>添加一个自定义组件</Button>
      </div>
    );
  }
}

presenter 生命周期
presenter 默认提供三个生命周期：
- onFormCreated form 被创建时，这时 form 实例被生成, form 组件还未渲染，函数参数接受 form 实例
- onFormMount form 组件被渲染
- onFormDestroy form 组件被卸载

presenter 默认提供提交按钮，有时候需要自定义提交按钮，屏蔽提交按钮只需传入：

this.presenter = new FormPresenter({
  formItems: info,
  initFormValues: {},
  disableSubmitButton: true, // 屏蔽提交按钮
});

组件布局

默认提供两种布局

grid
flow

grid 布局可以指定每个字段所占的空间：

this.presenter = new FormPresenter({
  formItems: info,
  initFormValues: {},
  formLayout: {
    type: "grid",
    col: 8, // 每个field占据8个栅格（总共24）
  },
});

表单默认布局为 flow 布局

presenter 可选参数

formItem 可选参数

IOptions 可选参数

| 参数 | 说明 | 类型 | 默认值 | 必填 | | :---- | :--------------- | :----- | :----- | :--- | | key | options 的 key | string | | 是 | | Title | options 的 title | string | | 是 |

IuploadProps 可选参数

| 参数 | 说明 | 类型 | 默认值 | 必填 | | :------------ | :------------------------------ | :----- | :----- | :--- | | action | 上传文件的地址 | string | | 否 | | maxFileLength | 上传的最大文件数量 | number | | 否 | | fileTypes | 上传文件的类型 | Array | | 否 | | fileSize | 单个文件上传的限制大小单位：MB | number | 2 | 否 |

IformLayout 可选参数

| 参数 | 说明 | 类型 | 默认值 | 必填 | | :--------- | :--------------------------------------- | :------------------------- | :----------- | :--- | | type | 布局类型 | string，可选‘grid’和‘flow’ | flow | 否 | | Col | 当 type 为 grid 时，每个 grid 占据的空间 | number | 8（总共 24） | 否 | | labelCol | 当布局为 flow 时，字段 label 占据的空间 | object | {span: 6} | 否 | | wrapperCol | 当布局为 flow 时，字段值占据的空间 | object | {span: 14} | 否 |

uiTypeEnums 可选的值

presenter 的公共方法

getFormComponent 获取 form 组件实例

const presenter = new FormPresenter<IFormProps>({
      formItems: refundFormItems
    })
render() {
  const FormComponent = presenter.getFormComponent()
  return (
    <FormComponent/>
  )
}

getForm 返回 form 实例

const presenter = new FormPresenter<IFormProps>({
      formItems: refundFormItems
    })

submit() {
  // 在表单提交的时候做校验
  const form = presenter.getForm()
  form.validateFields((err, values) => {
      if (!err) {
        console.log('Form返回的值为：', values)
      }
    })
}

addFormItem 动态增加一个 form 的字段

const presenter = new FormPresenter<IFormProps>({
      formItems: refundFormItems
    })
componentDidMount() {
  // 动态增加一个input类型的字段
  presenter.addFormItem({
      label: '身高',
      key: 'high',
      uiType: 'input', // 添加类型为input
      rules: [
        {
          required: false,
          message: '',
        },
      ]
    }, 0) // 添加为第一个字段
  // 动态增加一个自定义渲染的字段
  presenter.addFormItem({
      label: '描述',
      key: 'desc',
      uiType: 'custom', // 添加类型为自定义组件
      rules: [
        {
          required: false,
          message: '',
        },
      ],
    render: () => <span>自定义渲染的字段</span>,
    }, 2) // 添加为第三个字段
}

hasField 判断表单是否含有某字段
```
this.presenter.hasField("name"); // true
```
getFormItems 获取表单全部字段配置
```
this.presenter.getFormItems();
```

updateFormItem 更新某字段

this.presenter.updateFormItem({
  key: "name",
  label: "更新--姓名",
  uiType: "input",
});

resetFields 把 form 重置回初始值的状态
```
this.presenter.resetFields();
```

总结

FormPresenter 是基于 ant design Form 封装的，基于模型驱动的组件，可满足日常大部分表单组件的快速开发，是模型驱动 MDD 模式下一种表单解决方案。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

简介