# @synerise/ds-checkbox-tristate

> Checkbox Tristate 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-tristate
pnpm add @synerise/ds-checkbox-tristate
yarn add @synerise/ds-checkbox-tristate
bun add @synerise/ds-checkbox-tristate
```

## 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 | 2021-02-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dariusz Arciszewski |
| Maintainers | synerise |

## Links

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

## 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.1.48 — 2026-08-18
- 1.1.47 — 2026-08-11
- 1.1.46 — 2026-07-23
- 1.1.45 — 2026-06-27
- 1.1.44 — 2026-06-17
- 1.1.43 — 2026-06-11
- 1.1.42 — 2026-05-26
- 1.1.41 — 2026-05-22
- 1.1.40 — 2026-05-13
- … 181 more at https://npm.io/package/@synerise/ds-checkbox-tristate/versions

## README

---
id: checkbox-tristate
title: CheckboxTristate
---

> **DEPRECATED.** Use `<Checkbox tristate />` from `@synerise/ds-checkbox` instead. This package is a thin compatibility shim and will be removed in a future release.

CheckboxTristate UI Component - Expands Checkbox to third undefined state.

## Installation

```
npm i @synerise/ds-checkbox-tristate
or
yarn add @synerise/ds-checkbox-tristate
```

## Usage

```
import CheckboxTristate, { CheckboxTristateChangeEvent } from '@synerise/ds-checkbox-tristate';

<CheckboxTristate
  checked={checkedValue}
  onChange={(event: CheckboxTristateChangeEvent) => {
    console.log(event.target.checked); // this will return false|true|undefined
  }}
/>

```

## Demo

<iframe src="/storybook-static/iframe.html?id=components-checkbox-tristate--default"></iframe>

## API

| Property       | Description                                                           | Type                                  | Default   |
| -------------- | --------------------------------------------------------------------- | ------------------------------------- | --------- | ----------- |
| autoFocus      | Get focus when component mounted                                      | boolean                               | `false`   |
| checked        | Specifies whether the checkbox is selected or indeterminate           | boolean                               | undefined | `undefined` |
| 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               | ReactNode                             | -         |
| hasError       | Determines if checkbox is in error state                              | boolean                               | `false`   |
| onChange       | The callback function that is triggered when the state changes.       | (e:CheckboxTristateChangeEvent)=>void | -         |
| withoutPadding | Reset padding of CheckboxWrapper                                      | boolean                               | `false`   |

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