Interface FormItemProps

interface FormItemProps {
    autoSubmit?: boolean;
    children?: ChildrenType<any>;
    className?: string;
    colon?: boolean;
    dependencies?: any[];
    extra?: ReactNode;
    fieldId?: string;
    fieldKey?: Key | Key[];
    full?: boolean;
    getValueFromEvent?: ((...args) => any);
    getValueProps?: ((value) => Record<string, unknown>);
    hasFeedback?: boolean | {
        icons: FeedbackIcons;
    };
    help?: ReactNode;
    hidden?: boolean;
    htmlFor?: string;
    id?: string;
    initialValue?: any;
    isList?: boolean;
    isListField?: boolean;
    label?: ReactNode;
    labelAlign?: FormLabelAlign;
    labelCol?: Antd.ColProps;
    like?: boolean;
    messageVariables?: Record<string, string>;
    name?: any;
    noStyle?: boolean;
    normalize?: ((value, prevValue, allValues) => any);
    onMetaChange?: ((meta) => void);
    onReset?: (() => void);
    optional?: boolean;
    prefixCls?: string;
    preserve?: boolean;
    required?: boolean;
    requiredRule?: string | boolean;
    rootClassName?: string;
    rules?: FormRule[];
    shouldUpdate?: ShouldUpdate<any>;
    skeleton?: boolean | MergeWithAs<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, any, Assign<DevfiveProps, MotionProps>, As>;
    status?: "" | "error" | "success" | "warning" | "validating";
    style?: CSSProperties;
    tooltip?: LabelTooltipType;
    trigger?: string;
    validateDebounce?: number;
    validateFirst?: boolean | "parallel";
    validateStatus?: "" | "error" | "success" | "warning" | "validating";
    validateTrigger?: string | false | string[];
    valuePropName?: string;
    wrapperCol?: Antd.ColProps;
}

Hierarchy (view full)

Properties

autoSubmit? children? className? colon? dependencies? extra? fieldId? fieldKey? full? getValueFromEvent? getValueProps? hasFeedback? help? hidden? htmlFor? id? initialValue? isList? isListField? label? labelAlign? labelCol? like? messageVariables? name? noStyle? normalize? onMetaChange? onReset? optional? prefixCls? preserve? required? requiredRule? rootClassName? rules? shouldUpdate? skeleton? status? style? tooltip? trigger? validateDebounce? validateFirst? validateStatus? validateTrigger? valuePropName? wrapperCol?

Properties

Optional autoSubmit

autoSubmit?: boolean

Optional children

children?: ChildrenType<any>

Optional className

className?: string

Optional colon

colon?: boolean

Optional dependencies

dependencies?: any[]

Set up dependencies field. When dependencies field update and current field is touched, will trigger validate rules and render.

Optional extra

extra?: ReactNode

Optional fieldId

fieldId?: string

Optional fieldKey

fieldKey?: Key | Key[]

Deprecated

No need anymore

Optional full

full?: boolean

Optional getValueFromEvent

getValueFromEvent?: ((...args) => any)

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: EventArgs

      Returns any

Optional getValueProps

getValueProps?: ((value) => Record<string, unknown>)

Type declaration

    • (value): Record<string, unknown>

    • Parameters

      • value: any

      Returns Record<string, unknown>

Optional hasFeedback

hasFeedback?: boolean | {
    icons: FeedbackIcons;
}

Type declaration

  • icons: FeedbackIcons

Optional help

help?: ReactNode

Optional hidden

hidden?: boolean

Optional htmlFor

htmlFor?: string

Optional id

id?: string

Optional initialValue

initialValue?: any

Optional Private isList

isList?: boolean

Passed by Form.List props. Do not use since it will break by path check.

Optional Private isListField

isListField?: boolean

Passed by Form.List props. Do not use since it will break by path check.

Optional label

label?: ReactNode

Optional labelAlign

labelAlign?: FormLabelAlign

Optional labelCol

labelCol?: Antd.ColProps

Optional like

like?: boolean

Optional messageVariables

messageVariables?: Record<string, string>

Optional name

name?: any

Optional noStyle

noStyle?: boolean

Optional normalize

normalize?: ((value, prevValue, allValues) => any)

Type declaration

    • (value, prevValue, allValues): any

    • Parameters

      • value: any
      • prevValue: any
      • allValues: Store

      Returns any

Optional onMetaChange

onMetaChange?: ((meta) => void)

Type declaration

    • (meta): void

    • Parameters

      • meta: MetaEvent

      Returns void

Optional onReset

onReset?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional optional

optional?: boolean

Optional prefixCls

prefixCls?: string

Optional preserve

preserve?: boolean

Optional required

required?: boolean

Optional requiredRule

requiredRule?: string | boolean

Optional rootClassName

rootClassName?: string

Optional rules

rules?: FormRule[]

Optional shouldUpdate

shouldUpdate?: ShouldUpdate<any>

Optional skeleton

skeleton?: boolean | MergeWithAs<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, any, Assign<DevfiveProps, MotionProps>, As>

Optional status

status?: "" | "error" | "success" | "warning" | "validating"

Optional style

style?: CSSProperties

Optional tooltip

tooltip?: LabelTooltipType

Optional trigger

trigger?: string

Optional validateDebounce

validateDebounce?: number

Trigger will after configured milliseconds.

Optional validateFirst

validateFirst?: boolean | "parallel"

Optional validateStatus

validateStatus?: "" | "error" | "success" | "warning" | "validating"

Optional validateTrigger

validateTrigger?: string | false | string[]

Optional valuePropName

valuePropName?: string

Optional wrapperCol

wrapperCol?: Antd.ColProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc