Skip to content

Properties

PropertyTypeDescription
checkedboolean(optional) Determine whether the checkbox is checked or not. The default is false.
titleReactNode(optional) The title of the input - describing it a bit further for accessibility reasons.
labelReactNode(optional) Use either the label property or provide a custom one.
labelPositionstring(optional) Defines the position of the label. Use either left or right. Defaults to right.
labelSrOnlystring(optional) Use true to make the label only readable by screen readers.
sizestring
number
(optional) The size of the checkbox. For now there is "medium" (default) and "large".
indeterminateboolean(optional) Controls the checkbox indeterminate (partial) state.
statusstring(optional) Text with a status message. The style defaults to an error message. You can use true to only get the status color, without a message.
statusStateerror
info
(optional) Defines the state of the status. Currently, there are two statuses [error, info]. Defaults to error.
statusPropsFormStatusProps(optional) Use an object to define additional FormStatus properties. See FormStatus
globalStatusobject(optional) The configuration used for the target GlobalStatus
skeletonboolean(optional) If set to true, an overlaying skeleton with animation will be shown.
suffixReactNode(optional) Text describing the content of the Checkbox more than the label. You can also send in a React component, so it gets wrapped inside the Checkbox component.
innerRefReact.Ref(optional) By providing a React.ref we can get the internally used input element (DOM). E.g. innerRef={myRef} by using React.createRef() or React.useRef().
Spacestring
object
(optional) Spacing properties like top or bottom are supported.