Components
CheckboxField
Props

CheckboxFieldProps

Hierarchy

  • AriaCheckboxProps

    ↳ CheckboxFieldProps

Properties

error

• Optional error: boolean

Whether the field contains an error or not

Default

false;

Defined in

packages/components/src/checkbox/checkbox-field.tsx:52 (opens in a new tab)

errorText

• Optional errorText: ReactNode

Error message

Defined in

packages/components/src/checkbox/checkbox-field.tsx:56 (opens in a new tab)

helpText

• Optional helpText: ReactNode

Help message

Defined in

packages/components/src/checkbox/checkbox-field.tsx:60 (opens in a new tab)

indeterminate

• Optional indeterminate: boolean

Inherited from

AriaCheckboxProps.indeterminate

Defined in

packages/components/src/checkbox/use-aria-checkbox.ts:87 (opens in a new tab)

value

• Optional value: string

Inherited from

AriaCheckboxProps.value

Defined in

packages/components/src/checkbox/use-aria-checkbox.ts:88 (opens in a new tab)

CodeCode