react-ant-form-schema3

React basic ant form builder.

installation

npm install -S @feizheng/react-ant-form-schema3

update

npm update @feizheng/react-ant-form-schema3

properties

| Name | Type | Required | Default | Description | | ---------------- | ------ | -------- | --------------------------------------------------------- | ----------------------------------------------------- | | className | string | false | - | The extended className for component. | | actionsClassName | string | false | - | Action(submit) filed class name. | | initialValue | object | false | {} | Default fileds value object. | | items | array | false | [] | Form schema. | | template | func | false | - | The form field template. | | defaultComponent | any | false | Input | Default item component. | | onSubmit | func | false | noop | The onSubmit event. | | onChange | func | false | noop | The form filed onChange event. | | onFieldChange | func | false | noop | The item filed onChange event. | | onLoad | func | false | noop | When component did mount. | | formLayout | object | false | - | The formLayout for antd.Form. | | tailLayout | object | false | - | The formLayout for last form item (eg: like actions). | | submit | object | false | { type: 'primary', htmlType: 'submit', children: 'Save' } | The submit props. | | reset | object | false | - | The reset props. |

item options

| Name | Type | Description | | --------- | ------- | ---------------------------------------- | | label | string | The display label. | | filed | string | The form field string(name). | | component | element | The form field component. | | props | object | The form field props. | | options | object | The get decorator options(like rules). |

usage

1. import css

@import "~@feizheng/react-ant-form-schema3/dist/style.scss";

// customize your styles:
$react-ant-form-schema3-options: ()

2. import js

import ReactAntForm from '@feizheng/react-ant-form-schema3';
import { Input, Checkbox } from 'antd';
import ReactDOM from 'react-dom';
import React from 'react';
import ReactAntCheckbox from '@feizheng/react-ant-checkbox';
import noop from '@feizheng/noop';
import './assets/style.scss';

const formLayout = { labelCol: { span: 6 }, wrapperCol: { span: 16 } };
const tailLayout = { wrapperCol: { offset: 6, span: 16 } };

class App extends React.Component {
  state = {
    initialValue: {
      username: 'fei',
      chk: false,
      text: 'etst...'
    },
    items: [
      {
        label: '用户名',
        field: 'username',
        formLayout: { labelCol: { span: 6 }, wrapperCol: { span: 8 } },
        options: {
          rules: [{ required: true, message: '用户名为必选' }]
        }
      },
      {
        label: '密码',
        field: 'password',
        options: {
          rules: [{ required: true, message: '密码为必选' }]
        }
      },
      {
        label: '用户协议',
        field: 'chk',
        component: ReactAntCheckbox,
        props: {
          children: 'Agree the agreement'
        }
      },
      {
        label: '描述信息',
        field: 'text',
        component: Input.TextArea
      }
    ]
  };

  handleSubmit = (e) => {
    return new Promise((resolve, reject) => {
      console.log('submit:::', e);
    });
  };


  handleChange = (e) => {
    console.log('change.', e);
  };

  render() {
    return (
      <div className="app-container">
        <ReactAntForm
          formLayout={formLayout}
          tailLayout={tailLayout}
          items={this.state.items}
          initialValue={this.state.initialValue}
          onSubmit={this.handleSubmit}
          onChange={this.handleChange}
          submit={{
            type: 'primary',
            htmlType: 'submit',
            className: 'wp-10',
            children: '保存'
          }}
          reset={{
            children: '取消'
          }}
        />
      </div>
    );
  }
}

ReactDOM.render(<App />, document.getElementById('app'));

documentation

• https://afeiship.github.io/react-ant-form-schema/

license

Code released under the MIT license.