Interface FormItemProps

组件属性类型

interface FormItemProps {
    autoCompleteOptions?: string[];
    autoInitValue?: boolean;
    defaultValue?: any;
    deprecated?: string | boolean;
    disableVariableSetter?: boolean;
    docs?: string;
    extra?: ReactNode;
    footer?: ReactNode;
    getProp?: ((form: any) => Partial<Omit<IComponentProp<any>, "getProp">>);
    getSetterProps?: ((form: any) => any);
    getVisible?: ((form: any) => boolean);
    group?:
        | "basic"
        | "event"
        | "style"
        | "data"
        | "advanced";
    initValue?: any;
    name: string;
    noStyle?: boolean;
    options?: IOptionItem<string>[];
    placeholder?: string;
    props?: IComponentProp<any>[];
    setter?: string;
    setterProps?: any;
    template?: string;
    tip?: string;
    title?: string;
    validate?: ComponentPropValidate;
}

Hierarchy (view full)

Properties

autoCompleteOptions? autoInitValue? defaultValue? deprecated? disableVariableSetter? docs? extra? footer? getProp? getSetterProps? getVisible? group? initValue? name noStyle? options? placeholder? props? setter? setterProps? template? tip? title? validate?

Properties

OptionalautoCompleteOptions

autoCompleteOptions?: string[]

自动补全的提示值，仅对 ExpressionSetter 有效

OptionalautoInitValue

autoInitValue?: boolean

如果没提供 initValue，是否自动初始化

OptionaldefaultValue

defaultValue?: any

组件默认展示的值

Optionaldeprecated

deprecated?: string | boolean

标记属性是否已废弃

OptionaldisableVariableSetter

disableVariableSetter?: boolean

是否禁用变量绑定

Optionaldocs

docs?: string

帮助文档链接地址

Example

https://foo.bar/help

Optionalextra

extra?: ReactNode

表单项右侧自定义区域

Optionalfooter

footer?: ReactNode

表单项底部自定义区域

OptionalgetProp

getProp?: ((form: any) => Partial<Omit<IComponentProp<any>, "getProp">>)

动态设置属性，覆盖已有的 prop 对象

OptionalgetSetterProps

getSetterProps?: ((form: any) => any)

动态设置传递给 setter 的属性

Deprecated

请使用 getProp 代替

OptionalgetVisible

getVisible?: ((form: any) => boolean)

动态设置表单项是否展示

Optionalgroup

group?:
    | "basic"
    | "event"
    | "style"
    | "data"
    | "advanced"

属性的分组

  • basic 常用属性
  • style 样式属性
  • advanced 高级属性
  • event 事件属性
  • data 数据属性

OptionalinitValue

initValue?: any

首次拖拽后用来初始化组件的属性值

Example

"str" 字符串

Example

1 数字

Example

"{() => {}}" 函数

Example

"{1}" 表达式

Example

"%random()%" 内置命令

name

name: string

属性名

OptionalnoStyle

noStyle?: boolean

无样式模式，仅返回 setter 组件

Optionaloptions

options?: IOptionItem<string>[]

配置项的可选值，setterProps.options 的简写

Optionalplaceholder

placeholder?: string

输入提示

Optionalprops

props?: IComponentProp<any>[]

如果是对象属性，这里声明子属性列表

Optionalsetter

setter?: string

设置器

OptionalsetterProps

setterProps?: any

传递给设置器的属性

Optionaltemplate

template?: string

value 的模板，一般用于函数类型的属性，便于 setter 用来拼装返回值

Example

"(arg1, arg2, arg3) => {  {{content}}}"

Optionaltip

tip?: string

属性提示信息

Optionaltitle

title?: string

属性中文名

Optionalvalidate

validate?: ComponentPropValidate

表单值校验逻辑

Settings

Member Visibility

On This Page

Properties