# @brighthr/component-checkbox

> To install, type the following into the command line at the root of your project:

Latest version **2.0.8** (published 2026-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @brighthr/component-checkbox
pnpm add @brighthr/component-checkbox
yarn add @brighthr/component-checkbox
bun add @brighthr/component-checkbox
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.8 |
| Published | 2026-02-13 |
| First published | 2022-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 32.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | bright.hr |

## Links

- npm: https://www.npmjs.com/package/@brighthr/component-checkbox
- npm.io page: https://npm.io/package/@brighthr/component-checkbox

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [@brighthr/icons](https://npm.io/package/@brighthr/icons.md) ^1.131.0

## Recent versions

- 2.0.8 (latest) — 2026-02-13
- 2.0.7 — 2026-01-07
- 2.0.6 — 2024-09-26
- 2.0.5 — 2024-06-10
- 2.0.4 — 2024-05-13
- 2.0.3 — 2024-02-21
- 2.0.2 — 2024-01-25
- 2.0.1 — 2023-12-22
- 2.0.0 — 2023-10-05
- 1.1.3 — 2023-10-03
- 1.1.2 — 2023-09-20
- 1.1.1 — 2023-09-01
- 1.1.0 — 2023-09-01
- 1.0.2 — 2023-08-22
- 1.0.1 — 2023-08-03
- … 23 more at https://npm.io/package/@brighthr/component-checkbox/versions

## README

## Checkbox

To install, type the following into the command line at the root of your project:

```
npm i @brighthr/component-checkbox
```
To implement the Checkbox component into your project you’ll need to add the import:

```javascript
import Checkbox from '@brighthr/component-checkbox';
```
After adding import into your project you can use it simply like:

```jsx
<Checkbox />
```
## Props

| Name               | Type               | Default  | Description                                                           |
|--------------------|--------------------|----------|-----------------------------------------------------------------------|
| checkboxButton     | `boolean`          | `false`  | If `true`, gives the checkbox a button appearance.                    |
| checkboxButtonSize | `'sm'` `'base'`    | `'base'` | Sets the size of the button appearance if `checkboxButton` is `true`. |
| checkboxPosition   | `'left'` `'right'` | `'left'` | Sets the position of the checkbox.                                    |
| checked            | `boolean`          | `false`  | If `true`, the checkbox will show as selected.                        |
| circularCheckbox   | `boolean`          | `false`  | If `true`, the checkbox will be circular.                             |
| description        | `string`           |          | Sets a description to show.                                           |
| disabled           | `boolean`          | `false`  | If `true`, disables the checkbox with a gray overlay.                 |
| iconName           | `string`           |          | Sets the icon to display, no icon is displayed if left empty.         |
| label              | `string`           |          | Sets the label.                                                       |

---
_Source: https://npm.io/package/@brighthr/component-checkbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._