API Reference
Checkbox groups allow users to select multiple options from a list.
<CheckboxGroup label="Checkbox group"> <Checkbox value="1">Option 1</Checkbox> <Checkbox value="2">Option 2</Checkbox> </CheckboxGroup>
Parameters
props
- Type:
@vtex/shoreline-components.CheckboxGroupProps & @types/react.React.RefAttributes<typescript.HTMLInputElement>
Props
description (optional)
Checkbox group description
- Type:
@types/react.React.ReactNode
error (optional)
Whether the checkbox group is in an error state
- Type:
boolean
errorText (optional)
Checkbox group error message
- Type:
@types/react.React.ReactNode
horizontal (optional)
Whether the checkbox group is horizontal or vertical
-
Type:
boolean -
Default:
false
label
Checkbox group label
- Type:
@types/react.React.ReactNode