# @eisgs/checkbox

> Чекбокс может быть как с контентом, так и без него

Latest version **2.1.0** (published 2024-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eisgs/checkbox
pnpm add @eisgs/checkbox
yarn add @eisgs/checkbox
bun add @eisgs/checkbox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2024-02-19 |
| First published | 2021-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 50.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | traidersu, krll_mdntsv, lzdyd |

## Links

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

## Dependencies (3)

- [@eisgs/hint](https://npm.io/package/@eisgs/hint.md) ^3.0.0
- [@eisgs/typography](https://npm.io/package/@eisgs/typography.md) ^1.3.1
- [@eisgs/theme-provider](https://npm.io/package/@eisgs/theme-provider.md) ^0.0.8

## Recent versions

- 2.1.0 (latest) — 2024-02-19
- 2.0.0 — 2023-03-02
- 1.3.3 — 2022-11-07
- 1.3.2 — 2022-10-27
- 1.3.1 — 2022-07-19
- 1.3.0 — 2022-06-02
- 1.1.4 — 2022-04-05
- 1.1.3 — 2022-02-24
- 1.1.2 — 2022-01-26
- 1.1.0 — 2021-12-29
- 1.0.8 — 2021-09-17
- 1.0.7 — 2021-07-16
- 1.0.6 — 2021-06-11
- 1.0.5 — 2021-06-07
- 1.0.4 — 2021-06-04
- … 3 more at https://npm.io/package/@eisgs/checkbox/versions

## README

### Компонент Checkbox

Чекбокс может быть как с контентом, так и без него

```jsx
<Checkbox />
<Checkbox>Checkbox</Checkbox>
<Checkbox checked>Checkbox выбран</Checkbox>
```

### Управляемый Checkbox

Для управления компонентом необходимо использовать `checked` и `onChange`

```jsx
const [checked, setChecked] = React.useState();

<Checkbox checked={checked} onChange={setChecked}>
  Управляемый чекбокс
</Checkbox>;
```

### disabled

`disabled` позволяет блокировать ввод данных

```jsx
<Checkbox disabled>
  Checkbox заблокирован
</Checkbox>
<Checkbox checked disabled>
  Checkbox выбран и заблокирован
</Checkbox>
```

### onConfirmChange

```jsx
const [checked, setChecked] = React.useState();

const handleConfirm = (isChecked, onChange) => {
  const answer = confirm(`Вы уверены, что хотите ${isChecked ? 'согласиться' : 'отказаться'} ?`);

  onChange(isChecked === answer);
};

<Checkbox 
  checked={checked} 
  onChange={setChecked} 
  onConfirmChange={handleConfirm}
>
  Управляемый чекбокс
</Checkbox>
```

### Ошибки (ЕИСЖС)

При наличии `error` текст ошибки отобразится под компонентом

```jsx
const [checked, setChecked] = React.useState();

<div style={{ width: '300px' }}>
  <Checkbox
    checked={checked}
    error="Ошибка"
    onChange={setChecked}
  >
    Управляемый чекбокс с очень и очень длинным текстом
  </Checkbox>
</div>
```

### Подсказка (ЕИСЖС)

При передаче `hint` отобразится подсказка

```jsx
<div style={{ width: '300px' }}>
  <Checkbox hint="Подсказка">
    Чекбокс с подсказкой
  </Checkbox>
  <Checkbox hint="Подсказка">
    Чекбокс с длинным описанием и подсказкой
  </Checkbox>
</div>
```

### indeterminate

```jsx
import { useTheme } from "@eisgs/theme-provider";

const { value: theme } = useTheme();
const items = Array.from(Array(5)).map((_, index) => ({value: index, label: `Пункт ${index + 1}`}));
const defaultCheckedItems = items.map(({value}) => value % 2 === 0);

const [checkedList, setCheckedList] = React.useState(defaultCheckedItems);
const [indeterminate, setIndeterminate] = React.useState(true);
const [checkAll, setCheckAll] = React.useState(false);

const handleOptionChange = (val, event) => {
  const { name } = event.target;
    
  const newCheckedList = checkedList.map((item, index) => index === name ? val : item);
  const { length: newCheckedItemLength } = newCheckedList.filter(item => item);

  setCheckedList(newCheckedList);
  setCheckAll(newCheckedItemLength === defaultCheckedItems.length);
  setIndeterminate(newCheckedItemLength && newCheckedItemLength !== defaultCheckedItems.length);
}

const handleAllChange = (val) => {
  setCheckAll(val);
  setIndeterminate(false);
  setCheckedList(prev => prev.map(() => val));
}

<div className="w400">
  <Checkbox checked={checkAll} onChange={handleAllChange} indeterminate={indeterminate}>Выбрать все</Checkbox>
  <div style={{paddingTop: 20, paddingLeft: 20, borderTop: `2px solid ${theme.G3}`}}>
    {items.map(({value, label}, index) => (
      <Checkbox
        key={label}
        onChange={handleOptionChange}
        name={value}
        checked={checkedList[index]}
      >
        {label}
      </Checkbox>
    ))}
  </div>
</div>
```

### view (ИЖС)

Доступные значения `desktop` и `mobile`. Значение по умолчанию `desktop`

```jsx
const views = ['desktop', 'mobile'];

<div style={{display: 'flex'}}>
  {views.map(view => <Checkbox key={view} view={view} styles={{marginRight: 16}}>{view}</Checkbox>)}
</div>
```

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