Wrapper

The Checkbox component wrapper.

This is a compound component.

API

This component extends the native <div> API. That's why the className prop is not included in the table.

Props
Type
Required

children

ReactNode

labelPosition

'before' | 'after'

isDisabled

boolean

hasError

boolean

children

The children in this case, because it is a compound component, should be the ones provided by this design system.

labelPosition

A string that controls the render position of the label if passed as children.

isDisabled

Disable the component by changing its state.

hasError

Make the component show an error state.

x

Last updated