Skip to main content

<CheckboxGroup />

Props

name: string

Name of the checkbox group. Should match name given in initialValues/validationSchema.

label?: string

Label for the group or checkboxes.

groupClassName?: string

Class name to apply to the form control.

labelClassName?: string

Class name to apply to the Label. Default is Legend styling

helpId?: string

Help topic id, adds <FieldHelpIcon/> next to the label (should not be within label for accessibility).

required?: boolean

Will add <RequiredAsterisk /> to label.

isHelpVideoType?: boolean

Allows the type of <FieldHelpIcon/> to be changed between help-icon and video-help