Skip to content

CommonForm

Public form.

Basic Usage

loading

Form Default Parameters

Used in main.ts

js
registerComponentDefaultPropsMap({
  CommonForm: {
    size: 'large', // Size configuration
    col: {
      // Default column configuration
      sm: 24,
      md: 12,
      lg: 8,
      xl: 6,
    },
    //... other elForm parameters
  },
});

Span Set Width

loading

Hide Fields

loading

Switch Components

loading

Disable Fields

loading

Functional Configuration Parameters

For example, elSelect's change event. CommonForm uniformly appends parameters to functional configurations

loading

Field Slots

loading

Validation Rules

loading

API

MethodDescription
validateFormForm validation
...Other elForm exposed methods

Props

AttributeDescriptionTypeDefault
configComponent generation configurationCommonFormConfig[]None
...Other elForm parametersCommonFormPropsNone

CommonFormConfig Object Parameters

AttributeDescriptionTypeRequired
componentSpecifies the form component name to be used, such as 'input', 'select', etc. Default is inputstringNo
spanNumber of columns occupied by the form item in the layout (based on 24 grid system)numberNo
hiddenControls whether the form item is hidden, supports boolean or functionboolean | ({formData: any, configItem: any}) => booleanNo
isDisabledControls whether the form item is disabledboolean | (formData: any, configItem: any) => booleanNo
labelFieldCustom label display field namestringNo
formItemPropsAdditional attributes passed to el-form-item{ labelWidth?: string; [key: string]: any }No
rulesForm validation rules, can be an array or a function returning rulesArray<FormItemRule> | (formData: any, item: CommonFormConfig) => Array<FormItemRule>No