Hero Hook Form API / CustomFieldConfig

Interface: CustomFieldConfig<TFieldValues>

Defined in: types.ts:171

Extends

BaseFormFieldConfig<TFieldValues>

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

name

name: Path<TFieldValues>

Defined in: types.ts:41

Inherited from

BaseFormFieldConfig.name

label?

optional label: string

Defined in: types.ts:42

Inherited from

BaseFormFieldConfig.label

description?

optional description: string

Defined in: types.ts:43

Inherited from

BaseFormFieldConfig.description

className?

optional className: string

Defined in: types.ts:44

Inherited from

BaseFormFieldConfig.className

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:45

Inherited from

BaseFormFieldConfig.isDisabled

rules?

optional rules: RegisterOptions<TFieldValues, Path<TFieldValues>>

Defined in: types.ts:46

Inherited from

BaseFormFieldConfig.rules

condition()?

optional condition: (values) => boolean

Defined in: types.ts:49

Parameters

values

Partial<TFieldValues>

Returns

boolean

Inherited from

BaseFormFieldConfig.condition

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:50

Inherited from

BaseFormFieldConfig.dependsOn

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:51

Inherited from

BaseFormFieldConfig.dependsOnValue

group?

optional group: string

Defined in: types.ts:54

Inherited from

BaseFormFieldConfig.group

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:57

Inherited from

BaseFormFieldConfig.ariaLabel

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:58

Inherited from

BaseFormFieldConfig.ariaDescribedBy

type

type: "custom"

Defined in: types.ts:173

render()

render: (field) => ReactNode

Defined in: types.ts:174

Parameters

field

name

Path<TFieldValues>

control

Control<TFieldValues>

form

UseFormReturn<TFieldValues>

errors

FieldErrors<TFieldValues>

isSubmitting

boolean

Returns

ReactNode