Toggle theme
The Checkbox component is controlled component input field that handles user events. For more on controlled components see here.
All props, except for extend, will be passed through.
Name | Description | Type | Default Value |
|---|---|---|---|
checked | boolean ｜ undefined | n/a | |
description | Renders a description text underneath the input. | string ｜ undefined | n/a |
errorMessage | Renders a red error message for validation underneath the input. | string ｜ undefined | n/a |
isValid | boolean ｜ undefined | true | |
label | Accessible description of the outcome of interaction with the checkbox | ReactNode | n/a |
loading | Superfluous property returned from useField. Can be removed at a later date. | boolean ｜ undefined | n/a |
name | Renders a label inside the input. | string ｜ undefined | n/a |
onChange | ChangeEventHandler<HTMLInputElement> | n/a |