checked | boolean | (optional) Determine whether the checkbox is checked or not. The default is false. |
title | ReactNode | (optional) The title of the input - describing it a bit further for accessibility reasons. |
label | ReactNode | (optional) Use either the label property or provide a custom one. |
label_position | string | (optional) Defines the position of the label. Use either left or right. Defaults to right. |
label_sr_only | string | (optional) Use true to make the label only readable by screen readers. |
size | string or number | (optional) The size of the checkbox. For now there is "medium" (default) and "large". |
status | string | (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. |
status_state | error or info | (optional) Defines the state of the status. Currently, there are two statuses [error, info]. Defaults to error. |
status_props | FormStatusProps | (optional) Use an object to define additional FormStatus properties. See FormStatus |
globalStatus | object | (optional) The configuration used for the target GlobalStatus |
skeleton | boolean | (optional) If set to true, an overlaying skeleton with animation will be shown. |
suffix | ReactNode | (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. |
innerRef | string | (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(). |
Space | string or object | (optional) Spacing properties like top or bottom are supported. |