# @synerise/ds-checkbox

> Checkbox UI Component for the Synerise Design System

Latest version **2.0.5** (published 2026-09-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @synerise/ds-checkbox
pnpm add @synerise/ds-checkbox
yarn add @synerise/ds-checkbox
bun add @synerise/ds-checkbox
```

## Health

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

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2026-09-22 |
| First published | 2019-09-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | synerise |

## Links

- npm: https://www.npmjs.com/package/@synerise/ds-checkbox
- Repository: synerise/synerise-design
- npm.io page: https://npm.io/package/@synerise/ds-checkbox

## Recent versions

- 2.0.5 (latest) — 2026-09-22
- 2.0.4 — 2026-09-18
- 2.0.3 — 2026-09-16
- 2.0.2 — 2026-09-08
- 2.0.1 — 2026-09-02
- 2.0.0 — 2026-08-26
- 1.2.38 — 2026-08-18
- 1.2.37 — 2026-08-11
- 1.2.36 — 2026-07-23
- 1.2.35 — 2026-06-27
- 1.2.34 — 2026-06-17
- 1.2.33 — 2026-06-11
- 1.2.32 — 2026-05-26
- 1.2.31 — 2026-05-22
- 1.2.30 — 2026-05-13
- … 257 more at https://npm.io/package/@synerise/ds-checkbox/versions

## README

---
id: checkbox
title: Checkbox
---

Checkbox UI Component

Checkbox component

Based on [Ant Design Checkbox](https://ant.design/components/checkbox/)

## API

| Property       | Description                                                           | Type            | Default |
| -------------- | --------------------------------------------------------------------- | --------------- | ------- |
| autoFocus      | Get focus when component mounted                                      | boolean         | `false` |
| checked        | Specifies whether the checkbox is selected.                           | boolean         | `false` |
| defaultChecked | Specifies the initial state: whether or not the checkbox is selected. | boolean         | `false` |
| description    | Checkbox description                                                  | ReactNode       | -       |
| disabled       | Disable checkbox                                                      | boolean         | `false` |
| errorText      | Error message, if provided sets error state on checkbox               | string          | -       |
| hasError       | Determines if checkbox is in error state                              | boolean         | `false` |
| indeterminate  | Indeterminate checked state of checkbox                               | boolean         | `false` |
| onChange       | The callback function that is triggered when the state changes.       | (e:Event)=>void | -       |
| withoutPadding | Reset padding of CheckboxWrapper                                      | boolean         | `false` |
| tristate       | Tristate mode                                                         | true            | -       |

## Checkbox Group

| Property     | Description                                                     | Type                                                       | Default |
| ------------ | --------------------------------------------------------------- | ---------------------------------------------------------- | ------- |
| defaultValue | Default selected value                                          | string / number / boolean /string[] / number[] / boolean[] | []      |
| disabled     | Disable all checkboxes                                          | boolean                                                    | `false` |
| name         | The `name` property of all `input[type="checkbox"]` children    | string                                                     | -       |
| options      | Specifies options                                               | string / number / boolean /string[] / number[] / boolean[] | []      |
| value        | Used for setting the currently selected value.                  | string / number / boolean /string[] / number[] / boolean[] | []      |
| onChange     | The callback function that is triggered when the state changes. | (value: string / number / boolean) => void                 | -       |

### Methods

#### Checkbox

| Name    | Description  |
| ------- | ------------ |
| blur()  | remove focus |
| focus() | get focus    |

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