Skip to content
On this page

Interface: FormItemOptions

Properties

events

events: Record<string, any>

Defined in

dist/src/components/form-helper/form-item.d.ts:78


label

label: string

表单项标签

Defined in

dist/src/components/form-helper/form-item.d.ts:43


labelPrefix

Optional labelPrefix: (props: { field: FormItem<any> }) => VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

Type declaration

(props): VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

表单项标签前缀

Parameters
NameType
propsObject
props.fieldFormItem<any>
Returns

VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

Defined in

dist/src/components/form-helper/form-item.d.ts:75


labelSuffix

Optional labelSuffix: (props: { field: FormItem<any> }) => VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

Type declaration

(props): VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

表单项标签后缀

Parameters
NameType
propsObject
props.fieldFormItem<any>
Returns

VNode<RendererNode, RendererElement, { [key: string]: any; }> | VNode<RendererNode, RendererElement, { [key: string]: any; }>[]

Defined in

dist/src/components/form-helper/form-item.d.ts:69


name

name: string

表单项名称, 用于表单项的唯一标识. 必填项

Defined in

dist/src/components/form-helper/form-item.d.ts:39


required

required: boolean

Defined in

dist/src/components/form-helper/form-item.d.ts:51


rules

rules: Omit<RuleObject, "validator"> & { buildInValidator?: BuildInValidator ; validator?: (...args: any) => any }[]

表单项是否必填

Defined in

dist/src/components/form-helper/form-item.d.ts:47


slots

slots: Record<string, any>

Defined in

dist/src/components/form-helper/form-item.d.ts:79


valueMapTo

valueMapTo: string | <TYPE>(value: TYPE, rawData: Record<string, any>, options: FormItemOptions) => void

Deprecated

无法解决映射到多个未定义属性时的双向绑定问题. 表单项控件的值如何映射到表单绑定的 data 中. 默认为该表单项的 name 属性值.

  • 当值为字符串时, 表示映射到 data 中的字段名.
  • 当值为函数时, 可自定义映射逻辑. 函数参数为表单项控件的值和表单项控件的原始数据.
    typescript
    // 将表单项控件的值映射到 data 中的 field1 字段
    valueMapTo: (value) => {
      data["field1"] = value;
    }

Defined in

dist/src/components/form-helper/form-item.d.ts:65