Documents / @faasjs/ant-design / ExtendFormItemProps

Interface: ExtendFormItemProps

Extensible form item props that accept any string type.

Extends

• Omit<FormItemProps, "type">

Properties

children?

optional children?: UnionFaasItemElement<any> | null

Generic custom element rendered when no form-specific child overrides it.

Inherited from

Omit.children

col?

optional col?: number

Number of columns taken by this field in the Ant Design grid.

Inherited from

UnionFaasItemProps.col

disabled?

optional disabled?: boolean

Whether the field is disabled.

Inherited from

UnionFaasItemProps.disabled

extendTypes?

optional extendTypes?: ExtendTypes

Custom type renderers keyed by item type.

Inherited from

UnionFaasItemProps.extendTypes

formChildren?

optional formChildren?: UnionFaasItemElement<any> | null

Form-specific custom element.

Inherited from

Omit.formChildren

formRender?

optional formRender?: UnionFaasItemRender<any> | null

Form-specific custom render callback.

Inherited from

Omit.formRender

id

id: string | number

Inherited from

BaseItemProps.id

if?

optional if?: (values) => boolean

Conditional visibility predicate. When false, the field is hidden and rendered as a hidden input.

Parameters

values

Record<string, any>

Returns

boolean

Inherited from

Omit.if

input?

optional input?: InputProps | RadioProps | InputNumberProps<ValueType> | SwitchProps | DatePickerProps | SelectProps<any, DefaultOptionType>

Props forwarded to the Ant Design input component used for this field.

Inherited from

Omit.input

label?

optional label?: string | false

Field label text, or false to hide the label.

Inherited from

UnionFaasItemProps.label

maxCount?

optional maxCount?: number

Maximum number of entries allowed in a list item.

Inherited from

UnionFaasItemProps.maxCount

object?

optional object?: FormItemProps<any>[]

Nested item definitions used by object and object[] item types.

Inherited from

Omit.object

onValueChange?

optional onValueChange?: (value, values, form) => void

Called when the field value changes.

Parameters

value

any

values

any

form

FormInstance

Returns

void

Inherited from

Omit.onValueChange

options?

optional options?: BaseOption[]

Inherited from

BaseItemProps.options

render?

optional render?: UnionFaasItemRender<any> | null

Generic custom render callback.

Inherited from

Omit.render

required?

optional required?: boolean

Whether the field is required. When true, a required validation rule is appended.

Inherited from

UnionFaasItemProps.required

rules?

optional rules?: RuleObject[]

Validation rules appended to the field.

Inherited from

UnionFaasItemProps.rules

title?

optional title?: string

Inherited from

BaseItemProps.title

type?

optional type?: string