Hero Hook Form API v2.5.1

Hero Hook Form API / RadioFieldConfig

Interface: RadioFieldConfig<TFieldValues>

Defined in: types.ts:125 

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: "radio"

Defined in: types.ts:127 

defaultValue?

optional defaultValue: string

Defined in: types.ts:128 

radioProps?

optional radioProps: Omit<MergeWithAs<Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, Omit<Omit<any, "ref">, never>, RadioGroupProps, As<any>>, "label" | "value" | "onValueChange">

Defined in: types.ts:129 

radioOptions?

optional radioOptions: object[]

Defined in: types.ts:133 

label

label: string

value

value: string | number