ke-form v1.0.9

说明

一个支持配置化的表单（支持表单字段分组）组件，适用以下场景：

• 想要快速使用 配置（json） 初始化一个支持多种内置字段类型的表单。

• 想要对表单字段进行 分组 展示和分别调整布局，设置分组标题。

• 想要通过配置（json）声明式定义一些简单的 字段联动 效果。

• 对于没有的字段，能够快速 扩展 自定义字段。

安装

npm install ke-form

使用

import React , { Component } from 'react';
import { render } from 'react-dom';
import KeForm from 'ke-form';

// 表单配置，包括字段、布局、分组等
const formConfig = {
    fields: [{ // fields
        type: 'input',
        name: 'firstname',
        label: 'First Name',
    }]
};

// 表单初始值
const formData={
    firstname: 'tom'
};

// 表单上下文
const formContext={ 
    ucid: '1000000000'
};

render(
    <KeForm
        formConfig={formConfig} // 表单配置，必传，生效一次
        formData={formData} // 表单初始值，可选
        formContext={formContext} // 表单上下文，可选
        onCreate={(form) => {console.log(form)}} // 获取可交互表单实例，用于获取表单值，修改配置等
    />, document.body);

示例

在线示例

API

props

props.formConfig 表单配置

props.formConfig.style 表单样式

props.formConfig.groupsi 表单分组

props.formConfig.fieldsi 表单元素

props.formConfig.fieldsi.type 表单元素类型

对于每种字段类型，除了支持上述公共 Api ,因为字段本身是基于 antd 表单组件实现的，所以能够支持相应属性，需通过 props 配置属性传入, 不要传入 value 和 onChange 等与表单值有关的属性，会引起状态管理异常。

• text 纯文本

• input 文本框

• textarea 多行文本框

• select 选择器

• datepicker 日期选择器

• checkbox 多选框

• radio 单选框

• switch 开关

props.formConfig.ajax 选项数据加载

配置内部组件加载数据用到的ajax函数,需适配如下语法:

formConfig.ajax(url).then(data); // data 是转化后的最终数据,这些数据会被内部组件应用

• props.formData 表单初始值

用于初始化表单默认值, {key:value} 格式。

{
    field_name: 'field_value',
    // ...
}

• props.onCreate(form) 表单回调函数

原理：在底层实现上，回调参数 form 为 antd Form.create 方法创建表单得到的实例对象 this.props.form ， 本组件对其方法进行了扩展,以支持配置能力，扩展参数有：

props.formContext 表单业务上下文数据

• 上下文数据对象，可被表单内部组件访问，比如远程数据加载器， 根据配置的remote.url属性能够通过 http://${context.userid} 的方式动态填充 props.formContext.userid 数据。
• 扩展字段内部访问，通过 props.context方式访问。

FAQ

对于不支持的字段，如何快速扩展？

提供方法 plugin('field','fieldType', Component, options?:{initialValue? = ''}) 扩展字段，事实上内置字段也是通过该方法进行扩展的。

扩展字段可访问组件内部的方法，并需要实现指定接口，比如内置 input 类型的实现如下：

// ====== input.js ======
import React, { Component } from 'react';
import { Input } from 'antd';

export default class FieldInput extends Component {
  render() {
    // `this.props.config` 获取当前字段配置对象 
    // `this.props.value`, `this.props.onChange` 实现数据双向绑定
    // `this.props.form` 能够获取当前表单对象实例 ,从而向上与整个表单互动
    // `this.props.context` 能够获取当前表单上下文数据对象  
    let {
      value, 
      onChange, 
      config: { label, disabled, placeholder, props } 
    } = this.props;

    placeholder = placeholder || '请输入' + label;

    const _props = {
      disabled,
      placeholder,
      value,
      onChange,
      ...props
    }

    return (
      <Input {..._props}/>
    )
  }
}
// ====== / input.js ======

// ===== index.js ======
import React, { Component } from 'react';
import render from 'react-dom';
import Keform , { plugin } from 'ke-form';
import Input from './input.js';

// 注册 input 类型
plugin('field', 'input', Input, {
  initialValue: '' // 默认值是空字符串，所以本例也可以不指定
});

export default class App extends Component{
  render () {
    return  <Keform formConfig={{fields: [{type: ‘input’, name: 'fristname'}]}}/>
  }
}
// ===== /index.js ======