Skip to main content

Type Alias: InputRefType

InputRefType = object

Defined in: components/Form/types.ts:70

Description​

The ref object exposed by form input components.

Properties​

checkValidity()​

checkValidity: () => (string | boolean)[]

Defined in: components/Form/types.ts:74

A function to trigger validation.

Returns​

(string | boolean)[]

element​

element: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | null

Defined in: components/Form/types.ts:73

The DOM element of the input.

getValidity()​

getValidity: () => (string | boolean)[]

Defined in: components/Form/types.ts:75

A function to get the current validation errors.

Returns​

(string | boolean)[]

getValue()​

getValue: (args?) => any

Defined in: components/Form/types.ts:76

A function to get the current value of the input.

Parameters​

args?​

any

Returns​

any

isInputRefType​

isInputRefType: boolean

Defined in: components/Form/types.ts:71

A flag to identify this as an input ref.

name?​

optional name: string

Defined in: components/Form/types.ts:72

The name of the input.