Checkbox Field
Checkbox Field wraps a Checkbox input and its corresponding Label. It allows users to select one option from a set.
Overview
Import
Import the component from @faststore/ui
import { CheckboxField } from '@faststore/ui'
Import Styles
import '@faststore/ui/src/components/molecules/CheckboxField/styles.scss'
Usage
<CheckboxField label="Faststore" id="faststore" />
Props
Checkbox Field
Name | Type | Description | Default |
---|---|---|---|
testId | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-checkbox-field |
id* | string | ID to identify input and corresponding label. | |
label* | string | The text displayed to identify the input checkbox. | |
value | string | The value to identify the input checkbox. | |
name | string | Identify checkbox in the same group. |
Design Tokens
Local token | Default value/Global token linked |
---|---|
--fs-checkbox-field-gap | var(--fs-spacing-1) |
Customization
For further customization, you can use the following data attributes:
data-fs-checkbox-field