Hero Hook Form API v2.5.1

Hero Hook Form API / BaseFormFieldConfig

Interface: BaseFormFieldConfig<TFieldValues>

Defined in: types.ts:40 

Extended by

• StringFieldConfig
• BooleanFieldConfig
• RadioFieldConfig
• SliderFieldConfig
• DateFieldConfig
• FileFieldConfig
• FontPickerFieldConfig
• CustomFieldConfig
• ConditionalFieldConfig
• FieldArrayConfig
• DynamicSectionConfig

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

name

name: Path<TFieldValues>

Defined in: types.ts:41 

label?

optional label: string

Defined in: types.ts:42 

description?

optional description: string

Defined in: types.ts:43 

className?

optional className: string

Defined in: types.ts:44 

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:45 

rules?

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

Defined in: types.ts:46 

condition()?

optional condition: (values) => boolean

Defined in: types.ts:49 

Parameters

values

Partial<TFieldValues>

Returns

boolean

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:50 

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:51 

group?

optional group: string

Defined in: types.ts:54 

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:57 

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:58