Hero Hook Form API / CheckboxGroupFieldConfig

Interface: CheckboxGroupFieldConfig<TFieldValues>

Defined in: types.ts:194

Extends

BaseFormFieldConfig<TFieldValues>

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

name

name: Path<TFieldValues>

Defined in: types.ts:138

Inherited from

BaseFormFieldConfig.name

label?

optional label: string

Defined in: types.ts:139

Inherited from

BaseFormFieldConfig.label

description?

optional description: string

Defined in: types.ts:140

Inherited from

BaseFormFieldConfig.description

className?

optional className: string

Defined in: types.ts:141

Inherited from

BaseFormFieldConfig.className

isDisabled?

optional isDisabled: boolean

Defined in: types.ts:142

Inherited from

BaseFormFieldConfig.isDisabled

rules?

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

Defined in: types.ts:143

Inherited from

BaseFormFieldConfig.rules

condition()?

optional condition: (values) => boolean

Defined in: types.ts:146

Parameters

values

Partial<TFieldValues>

Returns

boolean

Inherited from

BaseFormFieldConfig.condition

dependsOn?

optional dependsOn: Path<TFieldValues>

Defined in: types.ts:147

Inherited from

BaseFormFieldConfig.dependsOn

dependsOnValue?

optional dependsOnValue: unknown

Defined in: types.ts:148

Inherited from

BaseFormFieldConfig.dependsOnValue

group?

optional group: string

Defined in: types.ts:151

Inherited from

BaseFormFieldConfig.group

ariaLabel?

optional ariaLabel: string

Defined in: types.ts:154

Inherited from

BaseFormFieldConfig.ariaLabel

ariaDescribedBy?

optional ariaDescribedBy: string

Defined in: types.ts:155

Inherited from

BaseFormFieldConfig.ariaDescribedBy

type

type: "checkboxGroup"

Defined in: types.ts:196

defaultValue?

optional defaultValue: (string | number)[]

Defined in: types.ts:197

checkboxGroupOptions?

optional checkboxGroupOptions: object[]

Defined in: types.ts:198

label

label: string

value

value: string | number

checkboxProps?

optional checkboxProps: CheckboxGroupPassthroughProps

Defined in: types.ts:199

orientation?

optional orientation: "horizontal" | "vertical"

Defined in: types.ts:200