Checkbox
The Checkbox component provides a user-friendly interface for toggling between checked and unchecked states, with customizable labels and state management.
Installation
Install the package
npm i @start-base/react-form-elementsAdd the styles
To use the React form elements styles in a Next.js project, import the styles in your layout.tsx file.
app/layout.tsx
import "@start-base/react-form-elements/styles.css";Import the component
import Checkbox from '@start-base/react-form-elements/Checkbox';Usages
Checkbox Component Checked
Checkbox Component Disabled
Checkbox Component Error
API
A basic checkbox input component.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | Name of the input | |
| label | string | null | Label of the input |
| placeholder | string | null | Placeholder of the input |
| onChange | function | Callback function that is fired when the value changes. | |
| inputClassName | string | null | Classname for input element |
| labelClassName | string | null | Classname for label element |
| errorClassName | string | null | Classname for error element |
| disabled | boolean | false | Disable the input |
| error | string or boolean or object | null | Error message to display below the input. if value is a boolean input border will be change. Also you can pass schema validator error objects. |
| checked | boolean | false | Checked state of the checkbox |