Interface FormInstance<Values>

interface FormInstance<Values> {
    getFieldError: ((name) => string[]);
    getFieldInstance: ((name) => any);
    getFieldValue: ((name) => any);
    getFieldWarning: ((name) => string[]);
    getFieldsError: ((nameList?) => FieldError[]);
    getFieldsValue: (() => Values) & ((nameList, filterFunc?) => any) & ((config) => any);
    isFieldTouched: ((name) => boolean);
    isFieldValidating: ((name) => boolean);
    isFieldsTouched: ((nameList?, allFieldsTouched?) => boolean) & ((allFieldsTouched?) => boolean);
    isFieldsValidating: ((nameList?) => boolean);
    resetFields: ((fields?) => void);
    scrollToField: ((name, options?) => void);
    setFieldValue: ((name, value) => void);
    setFields: ((fields) => void);
    setFieldsValue: ((values) => void);
    submit: (() => void);
    validateFields: ValidateFields<Values>;
}

Type Parameters

  • Values = any

Hierarchy

  • FormInstance<Values>
    • FormInstance

Properties

getFieldError getFieldInstance getFieldValue getFieldWarning getFieldsError getFieldsValue isFieldTouched isFieldValidating isFieldsTouched isFieldsValidating resetFields scrollToField setFieldValue setFields setFieldsValue submit validateFields

Properties

getFieldError

getFieldError: ((name) => string[])

Type declaration

    • (name): string[]

    • Parameters

      • name: any

      Returns string[]

getFieldInstance

getFieldInstance: ((name) => any)

Type declaration

    • (name): any

    • Parameters

      • name: any

      Returns any

getFieldValue

getFieldValue: ((name) => any)

Type declaration

    • (name): any

    • Parameters

      • name: any

      Returns any

getFieldWarning

getFieldWarning: ((name) => string[])

Type declaration

    • (name): string[]

    • Parameters

      • name: any

      Returns string[]

getFieldsError

getFieldsError: ((nameList?) => FieldError[])

Type declaration

    • (nameList?): FieldError[]

    • Parameters

      • Optional nameList: any[]

      Returns FieldError[]

getFieldsValue

getFieldsValue: (() => Values) & ((nameList, filterFunc?) => any) & ((config) => any)

Type declaration

Type declaration

    • (nameList, filterFunc?): any

    • Parameters

      • nameList: true | any[]
      • Optional filterFunc: FilterFunc

      Returns any

Type declaration

    • (config): any

    • Parameters

      • config: GetFieldsValueConfig

      Returns any

isFieldTouched

isFieldTouched: ((name) => boolean)

Type declaration

    • (name): boolean

    • Parameters

      • name: any

      Returns boolean

isFieldValidating

isFieldValidating: ((name) => boolean)

Type declaration

    • (name): boolean

    • Parameters

      • name: any

      Returns boolean

isFieldsTouched

isFieldsTouched: ((nameList?, allFieldsTouched?) => boolean) & ((allFieldsTouched?) => boolean)

Type declaration

    • (nameList?, allFieldsTouched?): boolean

    • Parameters

      • Optional nameList: any[]
      • Optional allFieldsTouched: boolean

      Returns boolean

Type declaration

    • (allFieldsTouched?): boolean

    • Parameters

      • Optional allFieldsTouched: boolean

      Returns boolean

isFieldsValidating

isFieldsValidating: ((nameList?) => boolean)

Type declaration

    • (nameList?): boolean

    • Parameters

      • Optional nameList: any[]

      Returns boolean

resetFields

resetFields: ((fields?) => void)

Type declaration

    • (fields?): void

    • Parameters

      • Optional fields: any[]

      Returns void

scrollToField

scrollToField: ((name, options?) => void)

Type declaration

    • (name, options?): void

    • Parameters

      • name: any
      • Optional options: Options

      Returns void

setFieldValue

setFieldValue: ((name, value) => void)

Type declaration

    • (name, value): void

    • Parameters

      • name: any
      • value: any

      Returns void

setFields

setFields: ((fields) => void)

Type declaration

    • (fields): void

    • Parameters

      • fields: FieldData[]

      Returns void

setFieldsValue

setFieldsValue: ((values) => void)

Type declaration

    • (values): void

    • Parameters

      • values: RecursivePartial<Values>

      Returns void

submit

submit: (() => void)

Type declaration

    • (): void

    • Returns void

validateFields

validateFields: ValidateFields<Values>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc