Global API

create

• Type:Function

• Parameter:

  • Array rules
  • Object options

• return value:

  • Object $f

• Description: Generate form

• Usage:

  const $f = formCreate.create(rules,options);

init

• Type:Function

• Parameter:

  • Array rules
  • Object options

• return value:

  • Function mount mount form
  • Function remove remove form
  • Function destroy destroys the form
  • Object $f

• Description: Create a form constructor

• Usage:

  const {$f,mount,remove,destroy} = formCreate.init(rules,options);
  //mount the form to #app
  mount(document.getElementById('app'));
  //Destroy the form
  remove();

component

• Type:Function

• Parameter:

  • string id
  • Object component

• Description: Mount custom components in form-create

• Usage:

  //mount component
  formCreate.component('test',component);
  //get the component
  const component = formCreate.component('test');

createParser

• Type:Function

• return value:

  • Parser parser

• Description: Create a new component parser

• Usage:

  const Parser = formCreate.createParser();

setParser

• Type:Function

• Parameter:

  • string componentName
  • Parser parser

• Description: Bind a component parser

• Usage:

  const Parser = formCreate.createParser();
  parser.prototype.toFormValue = (value)=>parseFloat(value)||0;
  formCreate.setParser('inputNumber',Parser);

maker

• type: Object

• Description: Component Builder

• Usage:

  rule = maker.input('testTitle','testField','testValue');

$form

• Type:Function

• Description: Bind a component parser

• Usage:

  $formCreate = formCreate.$form();
  //Local mount formCreate
  new vue({
      components:{
        'form-create': $formCreate
      }
  });
  //Global mount
  Vue.component('form-create',$formCreate);

parseJson

• Type:Function

• Parameter：

  • String json
  • Boolean mode

• Description: Convert json to a generation rule, add a second parameter for backward compatibility, use the new version to parse when mode: true (version> 1.0.5 recommends that the second parameter is fixed to true)

• Usage:

    const json = $f.toJson();
    const rule = formCreate.parseJson(json, true);

Event

change

• Parameter：

  • field
  • value
  • $f api

• Directions： Triggered when the value of the form component changes within the component

set-value

• Parameter：

  • field
  • value
  • $f api

• Directions： Triggered when the value of the form component modified externally

emit-event

• Parameter：

  • emitName
  • ...args event Parameter

• Directions： Triggered when the component’s emit event triggered

control

• Parameter：

  • rule rule
  • $f api

• Directions： Triggered when the component’s control becomes effective or invalid

mounted

• Parameter：

  • $f api

• Directions： Triggered after the form rendered for the first time

on-submit

• Parameter：

  • formData
  • $f api

• Directions： Triggered when the form submit button clicked

vm.$formCreate

• Type:Function

• Parameter:

  • Array rules
  • Object options

• return value:

  • Object $f

• Attributes:

  • Function component
  • Function createParser
  • Function setParser
  • Function $form
  • Function parseJson
  • Object maker

• Description: Generate form

• Usage:

  new vue({
    mounted(){
      Const $f = this.$formCreate(rules,options);
    }
  })