> ## Documentation Index
> Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Флажок

> Выбирайте независимые варианты с отмеченным и неопределенным состояниями.

## Обзор

Используйте `Checkbox`, когда каждый вариант можно выбрать независимо. Для взаимоисключающего выбора используйте [группу радиокнопок](https://docs.twenty.com/ru/ui/primitives/input/radio-group.md).

**Light**

[Пример Checkbox (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--display\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Пример Checkbox (dark)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--display\&viewMode=story\&globals=colorScheme:dark)

[Open in Storybook](https://storybook.twenty.com/?path=/story/ui-input-checkbox-checkbox--display)

## Использование

### Неуправляемое состояние

Используйте `defaultChecked`, чтобы задать начальное состояние флажка. Флажок управляет последующими изменениями.

```tsx theme={null}
import { useId } from 'react';
import { Checkbox } from 'twenty-ui/primitives/input';
import { Text } from 'twenty-ui/primitives/typography';

export const EmailPreference = () => {
  const checkboxId = useId();

  return (
    <label
      htmlFor={checkboxId}
      style={{ display: 'inline-flex', alignItems: 'center', gap: 8 }}
    >
      <Checkbox id={checkboxId} name="updates" value="email" defaultChecked />
      <Text render={<span />}>Receive product updates</Text>
    </label>
  );
};
```

Отмеченный флажок с именем добавляет свое значение в форму. Укажите `uncheckedValue`, если форма также должна отправлять значение, когда флажок не отмечен.

## Внешний вид и взаимодействие

Сравните состояния «отмечено», «неопределённое» и «отключено», затем независимо выберите цвет, размер, форму и вариант. Состояние активных примеров можно переключать.

**Light**

[Внешний вид и взаимодействие флажка (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--catalog\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Внешний вид и взаимодействие флажка (dark)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--catalog\&viewMode=story\&globals=colorScheme:dark)

[Open in Storybook](https://storybook.twenty.com/?path=/story/ui-input-checkbox-checkbox--catalog)

| Свойство | Значения | По умолчанию |
| - | - | - |
| `размер` | `sm`, `md` | `sm` |
| `variant` | `solid`, `outline`, `soft` | `solid` |
| `shape` | `square`, `round` | `square` |
| `цвет` | `accent`, `success`, `warning` | `accent` |

Клавиша Tab переводит фокус на флажок, а пробел переключает его. Щелчок по его метке также переключает его. Используйте `disabled`, чтобы запретить взаимодействие, или `readOnly`, если значение должно оставаться неизменным, а элемент управления должен сохранять возможность получения фокуса. Передавайте смысл в метке, а не только с помощью цвета.

## Управляемое состояние

Передайте `checked` и обновляйте его с помощью `onCheckedChange`, чтобы управлять тем же параметром в состоянии React. Функция обратного вызова получает следующее логическое значение и сведения о событии.

```tsx theme={null}
import { useId, useState } from 'react';
import { Checkbox } from 'twenty-ui/primitives/input';
import { Text } from 'twenty-ui/primitives/typography';

export const EmailPreference = () => {
  const checkboxId = useId();
  const [checked, setChecked] = useState(true);

  return (
    <label
      htmlFor={checkboxId}
      style={{ display: 'inline-flex', alignItems: 'center', gap: 8 }}
    >
      <Checkbox
        id={checkboxId}
        name="updates"
        value="email"
        checked={checked}
        onCheckedChange={setChecked}
      />
      <Text render={<span />}>Receive product updates</Text>
    </label>
  );
};
```

## Неопределенное состояние

Флажок в неопределенном состоянии обозначает частичный выбор. Определяйте его на основе дочерних параметров независимо от состояния флажка.

```tsx theme={null}
import { useState } from 'react';
import { Checkbox } from 'twenty-ui/primitives/input';

export const ColumnSelection = () => {
  const [showEmail, setShowEmail] = useState(true);
  const [showPhone, setShowPhone] = useState(false);

  return (
    <fieldset>
      <legend>Visible columns</legend>
      <label>
        <Checkbox
          checked={showEmail && showPhone}
          indeterminate={showEmail !== showPhone}
          onCheckedChange={(checked) => {
            setShowEmail(checked);
            setShowPhone(checked);
          }}
        />
        All columns
      </label>
      <label>
        <Checkbox checked={showEmail} onCheckedChange={setShowEmail} />
        Email
      </label>
      <label>
        <Checkbox checked={showPhone} onCheckedChange={setShowPhone} />
        Phone
      </label>
    </fieldset>
  );
};
```

## Части и пользовательское содержимое

`Checkbox` собирает стилизованный корневой элемент и его стандартные значки установки и неопределённого состояния. Используйте `Checkbox.Root` с `Checkbox.Indicator` для управления содержимым индикатора. Root управляет состоянием и внешним видом поля; Indicator отображает предоставленное вами содержимое.

```tsx theme={null}
import { IconCheck } from 'twenty-ui/icon';
import { Checkbox } from 'twenty-ui/primitives/input';

export const CustomPreference = () => (
  <Checkbox.Root aria-label="Updates" defaultChecked>
    <Checkbox.Indicator>
      <IconCheck aria-hidden />
    </Checkbox.Indicator>
  </Checkbox.Root>
);
```

`CheckboxRootProps` и `CheckboxIndicatorProps` — это публичные типы, экспортируемые из `twenty-ui/primitives/input`. Обе части принимают нативные атрибуты, обработчики, ссылки, `render` и обратные вызовы `className` и `style`, зависящие от состояния. `ref` Root указывает на видимый элемент управления; `inputRef` указывает на нативный input. Ссылка части указывает на её отображаемый элемент. Передайте `nativeButton` вместе с `render={<button />}`, когда заменяете Root кнопкой. Свойства внешнего вида относятся к Root; явные классы и стили объединяются со значениями по умолчанию.

Indicator получает состояния установки и неопределённости, включая состояние перехода. Установите `keepMounted`, чтобы сохранять неустановленный индикатор в DOM; стилизация по умолчанию скрывает его с помощью opacity. Переопределите его `style` или `className` для пользовательских переходов.

**Light**

[Композиция частей Checkbox (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-parts--composition\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Композиция частей Checkbox (dark)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-parts--composition\&viewMode=story\&globals=colorScheme:dark)

[Open in Storybook](https://storybook.twenty.com/?path=/story/ui-input-checkbox-parts--composition)

Вызываемая сборка и её тип `CheckboxProps` по-прежнему поддерживаются. Замените сборку на Root и его часть при предоставлении пользовательских значков вместо добавления другой части к дочерним элементам сборки.

Для сброса управляемой формы обработайте `onReset` формы и восстановите `checked` до начального значения. Base UI 1.8 не восстанавливает состояние неуправляемого компонента при нативном сбросе формы. `required`, `form`, `value` и `uncheckedValue` сохраняют вышестоящее поведение нативного input.

## Свойства

Справочник создан на основе общедоступных типов компонента. Нативные атрибуты, включая доступные имена и обработчики событий, также поддерживаются для частей, отрисовывающих элементы.

**checked** `boolean`

Whether the checkbox is currently ticked.

To render an uncontrolled checkbox, use the `defaultChecked` prop instead.

**className** `string | ((state: CheckboxRootState) =\> string | undefined)`

CSS class applied to the element, or a function that
returns a class based on the component's state.

**color** `"accent" | "success" | "warning"` (default: accent)

Color used while the checkbox is checked or indeterminate.

**defaultChecked** `boolean` (default: false)

Whether the checkbox is initially ticked.

To render a controlled checkbox, use the `checked` prop instead.

**disabled** `boolean` (default: false)

Whether the component should ignore user interaction.

**form** `string`

Identifies the form that owns the hidden input.
Useful when the checkbox is rendered outside the form.

**hoverable** `boolean` (default: true)

Adds padding and a hover background around the box.

**id** `string`

The id of the input element.

**indeterminate** `boolean` (default: false)

Whether the checkbox is in a mixed state: neither ticked, nor unticked.

**inputRef** `Ref\<HTMLInputElement\>`

A ref to access the hidden `<input>` element.

**name** `string`

Identifies the field when a form is submitted.

**nativeButton** `boolean` (default: false)

Whether the component renders a native `<button>` element when replacing it
via the `render` prop.
Set to `true` if the rendered element is a native button.

**onCheckedChange** `((checked: boolean, eventDetails: \{ reason: "none"; event: Event; cancel: () =\> void; allowPropagation: () =\> void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; \}) =\> void)`

Event handler called when the checkbox is ticked or unticked.

**parent** `boolean` (default: false)

Whether the checkbox controls a group of child checkboxes.

Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).

**readOnly** `boolean` (default: false)

Whether the user should be unable to tick or untick the checkbox.

**render** `ReactElement\<unknown, string | JSXElementConstructor\<any\>\> | ComponentRenderFn\<HTMLProps, CheckboxRootState\>`

Allows you to replace the component's HTML element
with a different tag, or compose it with another component.

Accepts a `ReactElement` or a function that returns the element to render.

**required** `boolean` (default: false)

Whether the user must tick the checkbox before submitting a form.

**shape** `"round" | "square"` (default: square)

Corner shape of the box.

**size** `"md" | "sm"` (default: sm)

Visual size of the checkbox.

**style** `CSSProperties | ((state: CheckboxRootState) =\> CSSProperties | undefined)`

Style applied to the element, or a function that
returns a style object based on the component's state.

**uncheckedValue** `string`

The value submitted with the form when the checkbox is unchecked.
By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.

**value** `string`

The checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted.
When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on".

**variant** `"outline" | "soft" | "solid"` (default: solid)

Visual style of the box: filled, outlined, or tinted.

### Checkbox.Root

**Root.checked** `boolean`

Whether the checkbox is currently ticked.

To render an uncontrolled checkbox, use the `defaultChecked` prop instead.

**Root.className** `string | ((state: CheckboxRootState) =\> string | undefined)`

CSS class applied to the element, or a function that
returns a class based on the component's state.

**Root.color** `"accent" | "success" | "warning"` (default: accent)

Color used while the checkbox is checked or indeterminate.

**Root.defaultChecked** `boolean` (default: false)

Whether the checkbox is initially ticked.

To render a controlled checkbox, use the `checked` prop instead.

**Root.disabled** `boolean` (default: false)

Whether the component should ignore user interaction.

**Root.form** `string`

Identifies the form that owns the hidden input.
Useful when the checkbox is rendered outside the form.

**Root.hoverable** `boolean` (default: true)

Adds padding and a hover background around the box.

**Root.id** `string`

The id of the input element.

**Root.indeterminate** `boolean` (default: false)

Whether the checkbox is in a mixed state: neither ticked, nor unticked.

**Root.inputRef** `Ref\<HTMLInputElement\>`

A ref to access the hidden `<input>` element.

**Root.name** `string`

Identifies the field when a form is submitted.

**Root.nativeButton** `boolean` (default: false)

Whether the component renders a native `<button>` element when replacing it
via the `render` prop.
Set to `true` if the rendered element is a native button.

**Root.onCheckedChange** `((checked: boolean, eventDetails: \{ reason: "none"; event: Event; cancel: () =\> void; allowPropagation: () =\> void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; \}) =\> void)`

Event handler called when the checkbox is ticked or unticked.

**Root.parent** `boolean` (default: false)

Whether the checkbox controls a group of child checkboxes.

Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).

**Root.readOnly** `boolean` (default: false)

Whether the user should be unable to tick or untick the checkbox.

**Root.render** `ReactElement\<unknown, string | JSXElementConstructor\<any\>\> | ComponentRenderFn\<HTMLProps, CheckboxRootState\>`

Allows you to replace the component's HTML element
with a different tag, or compose it with another component.

Accepts a `ReactElement` or a function that returns the element to render.

**Root.required** `boolean` (default: false)

Whether the user must tick the checkbox before submitting a form.

**Root.shape** `"round" | "square"` (default: square)

Corner shape of the box.

**Root.size** `"md" | "sm"` (default: sm)

Visual size of the checkbox.

**Root.style** `CSSProperties | ((state: CheckboxRootState) =\> CSSProperties | undefined)`

Style applied to the element, or a function that
returns a style object based on the component's state.

**Root.uncheckedValue** `string`

The value submitted with the form when the checkbox is unchecked.
By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.

**Root.value** `string`

The checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted.
When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on".

**Root.variant** `"outline" | "soft" | "solid"` (default: solid)

Visual style of the box: filled, outlined, or tinted.

### Checkbox.Indicator

**Indicator.className** `string | ((state: CheckboxIndicatorState) =\> string | undefined)`

CSS class applied to the element, or a function that
returns a class based on the component's state.

**Indicator.keepMounted** `boolean` (default: false)

Whether to keep the element in the DOM when the checkbox is not checked.

**Indicator.render** `ReactElement\<unknown, string | JSXElementConstructor\<any\>\> | ComponentRenderFn\<HTMLProps, CheckboxIndicatorState\>`

Allows you to replace the component's HTML element
with a different tag, or compose it with another component.

Accepts a `ReactElement` or a function that returns the element to render.

**Indicator.style** `CSSProperties | ((state: CheckboxIndicatorState) =\> CSSProperties | undefined)`

Style applied to the element, or a function that
returns a style object based on the component's state.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.