Hero Hook Form API v2.15.0

Hero Hook Form API / BaseFormFieldConfig

Interface: BaseFormFieldConfig<TFieldValues>

Defined in: types.ts:137 

Extended by

• StringFieldConfig
• BooleanFieldConfig
• RadioFieldConfig
• CheckboxGroupFieldConfig
• SliderFieldConfig
• DateFieldConfig
• FileFieldConfig
• FontPickerFieldConfig
• StringArrayFieldConfig
• ConditionalFieldConfig
• DynamicSectionConfig

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

name

name: Path<TFieldValues>

Defined in: types.ts:138 

label?

optional label: string

Defined in: types.ts:139 

description?

optional description: string

Defined in: types.ts:140 

className?

optional className: string

Defined in: types.ts:141 

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:142 

rules?

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

Defined in: types.ts:143 

condition()?

optional condition: (values) => boolean

Defined in: types.ts:146 

Parameters

values

Partial<TFieldValues>

Returns

boolean

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:147 

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:148 

group?

optional group: string

Defined in: types.ts:151 

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:154 

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:155