Hero Hook Form API / field

Variable: field

const field: object

Defined in: builders/TypeInferredBuilder.ts:426

Field type builders for individual field creation

Type Declaration

checkbox()

checkbox: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

description?

string

isDisabled?

boolean

className?

string

required?

boolean

Returns

TypeInferredBuilder<T>

date()

date: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

placeholder?

string

description?

string

isDisabled?

boolean

className?

string

Returns

TypeInferredBuilder<T>

email()

email: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

placeholder?

string

description?

string

isDisabled?

boolean

className?

string

Returns

TypeInferredBuilder<T>

file()

file: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

accept?

string

multiple?

boolean

description?

string

isDisabled?

boolean

className?

string

Returns

TypeInferredBuilder<T>

number()

number: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

placeholder?

string

description?

string

isDisabled?

boolean

className?

string

min?

number

max?

number

step?

number

Returns

TypeInferredBuilder<T>

radio()

radio: <T>(name, label, options, fieldOptions?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options

object[]

fieldOptions?

description?

string

isDisabled?

boolean

className?

string

orientation?

"horizontal" | "vertical"

Returns

TypeInferredBuilder<T>

select()

select: <T>(name, label, options) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options

object[]

Returns

TypeInferredBuilder<T>

slider()

slider: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

min?

number

max?

number

step?

number

description?

string

isDisabled?

boolean

className?

string

Returns

TypeInferredBuilder<T>

switch()

switch: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

description?

string

isDisabled?

boolean

className?

string

Returns

TypeInferredBuilder<T>

text()

text: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

placeholder?

string

description?

string

isDisabled?

boolean

className?

string

minLength?

number

maxLength?

number

pattern?

string

Returns

TypeInferredBuilder<T>

textarea()

textarea: <T>(name, label, options?) => TypeInferredBuilder<T>

Type Parameters

T

T extends FieldValues

Parameters

name

Path<T>

label

string

options?

placeholder?

string

description?

string

isDisabled?

boolean

className?

string

rows?

number

minLength?

number

Returns

TypeInferredBuilder<T>