Documents / @faasjs/ant-design / UnionFaasItemProps

Interface: UnionFaasItemProps<Value, Values>

Combined item props that spans form, description, and table definitions.

Extends

• FormItemProps.DescriptionItemProps.TableItemProps

Type Parameters

Value

Value = any

Values

Values = any

Properties

children?

optional children?: UnionFaasItemElement<Value, Values> | null

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

Overrides

FormItemProps.children

col?

optional col?: number

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

Inherited from

FormItemProps.col

descriptionChildren?

optional descriptionChildren?: UnionFaasItemElement<any> | null

Description-specific custom element.

Inherited from

DescriptionItemProps.descriptionChildren

descriptionRender?

optional descriptionRender?: UnionFaasItemRender<any> | null

Description-specific custom render callback.

Inherited from

DescriptionItemProps.descriptionRender

disabled?

optional disabled?: boolean

Whether the field is disabled.

Inherited from

FormItemProps.disabled

extendTypes?

optional extendTypes?: ExtendTypes

Custom type renderers keyed by item type.

Inherited from

FormItemProps.extendTypes

formChildren?

optional formChildren?: UnionFaasItemElement<any> | null

Form-specific custom element.

Inherited from

FormItemProps.formChildren

formRender?

optional formRender?: UnionFaasItemRender<any> | null

Form-specific custom render callback.

Inherited from

FormItemProps.formRender

id

id: string | number

Inherited from

FormItemProps.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

FormItemProps.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

FormItemProps.input

label?

optional label?: string | false

Field label text, or false to hide the label.

Inherited from

FormItemProps.label

maxCount?

optional maxCount?: number

Maximum number of entries allowed in a list item.

Inherited from

FormItemProps.maxCount

object?

optional object?: UnionFaasItemProps<Value, Values>[]

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

Overrides

FormItemProps.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

FormItemProps.onValueChange

options?

optional options?: BaseOption[]

Inherited from

FormItemProps.options

optionsType?

optional optionsType?: "auto"

Use built-in option inference for filters when supported.

Inherited from

TableItemProps.optionsType

render?

optional render?: UnionFaasItemRender<Value, Values> | null

Generic custom render callback.

Overrides

FormItemProps.render

required?

optional required?: boolean

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

Inherited from

FormItemProps.required

rules?

optional rules?: RuleObject[]

Validation rules appended to the field.

Inherited from

FormItemProps.rules

tableChildren?

optional tableChildren?: UnionFaasItemElement<any> | null

Table-specific custom element.

Inherited from

TableItemProps.tableChildren

tableRender?

optional tableRender?: UnionFaasItemRender<any> | null

Table-specific custom render callback.

Inherited from

TableItemProps.tableRender

title?

optional title?: string

Inherited from

FormItemProps.title

type?

optional type?: FaasItemType

Item type that determines which Ant Design control is rendered.

Inherited from

FormItemProps.type