Checkbox Component

About

This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.

Description

Handles display of checkboxes according to style guide conventions.

• https://zeroheight.com/990ea04ab/p/78ca74-controls/t/954639

API

| prop | type | required | default | explanation | |-----------|--------|----------|---------|--------------| | className | string | no | "" | Adds an optional classname to the component | | value | string | no | no | Input value for checkbox | | name | string | no | no | Input name attr | | hasError | boolean | no | false | Determines if the checkbox is in an error state | | id | string | yes | no | Input id attr | | helperText | string | no | undefined | Adds optional helper text for input | | checked | boolean | no | false | Determines checked status for input | | disabled | boolean | no | false | Determines input disabled state | | required | boolean | no | false | Determines if the checkbox input is a required field | | inputRef | any | no | undefined | Allows specifying react ref for input | | onChange | function | no | () => {} | Event handler for onchange events | | onClick | function(e: event) | no | () => {} | Event handler for onclick event on the checkbox input | | testId | string | no | "" | Allows an id to be added for testing purposes via the data-testid attr |