Hero Hook Form API / CustomFieldConfig

Interface: CustomFieldConfig<TFieldValues>

Defined in: types.ts:272

Extends

Omit<BaseFormFieldConfig<TFieldValues>, "name">

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

label?

optional label: string

Defined in: types.ts:139

Inherited from

DynamicSectionConfig.label

description?

optional description: string

Defined in: types.ts:140

Inherited from

StringArrayFieldConfig.description

className?

optional className: string

Defined in: types.ts:141

Inherited from

DynamicSectionConfig.className

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:142

Inherited from

DynamicSectionConfig.isDisabled

rules?

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

Defined in: types.ts:143

Inherited from

Omit.rules

condition()?

optional condition: (values) => boolean

Defined in: types.ts:146

Parameters

values

Partial<TFieldValues>

Returns

boolean

Inherited from

Omit.condition

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:147

Inherited from

Omit.dependsOn

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:148

Inherited from

DynamicSectionConfig.dependsOnValue

group?

optional group: string

Defined in: types.ts:151

Inherited from

DynamicSectionConfig.group

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:154

Inherited from

DynamicSectionConfig.ariaLabel

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:155

Inherited from

DynamicSectionConfig.ariaDescribedBy

type

type: "custom"

Defined in: types.ts:274

name

name: Path<TFieldValues> | ArrayPath<TFieldValues>

Defined in: types.ts:276

render()

render: (field) => ReactNode

Defined in: types.ts:277

Parameters

field

name

Path<TFieldValues> | ArrayPath<TFieldValues>

control

Control<TFieldValues>

form

UseFormReturn<TFieldValues>

errors

FieldErrors<TFieldValues>

isSubmitting

boolean

Returns

ReactNode