> ## 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.

# Переключить

> Элемент управления с меткой для включения или выключения с контролируемым и неконтролируемым состоянием.

## Обзор

Используйте `Switch` для настройки включения или выключения. Добавьте элементу управления видимую метку или доступное имя.

**Light**

[Пример переключателя (light)](https://storybook.twenty.com/iframe.html?id=ui-input-switch-switch--display\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Пример переключателя (dark)](https://storybook.twenty.com/iframe.html?id=ui-input-switch-switch--display\&viewMode=story\&globals=colorScheme:dark)

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

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

### Неконтролируемое состояние

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

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

export const NotificationsPreference = () => {
  const switchId = useId();

  return (
    <label
      htmlFor={switchId}
      style={{ display: 'inline-flex', alignItems: 'center', gap: 8 }}
    >
      <Switch id={switchId} name="notifications" />
      <Text render={<span />}>Email notifications</Text>
    </label>
  );
};
```

## Варианты внешнего вида

Сравните два размера во включенном, выключенном, отключенном, доступном только для чтения и сфокусированном состояниях. Используйте включенные примеры, чтобы попробовать переключение.

**Light**

[Варианты внешнего вида переключателя (light)](https://storybook.twenty.com/iframe.html?id=ui-input-switch-switch--catalog\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Варианты внешнего вида переключателя (dark)](https://storybook.twenty.com/iframe.html?id=ui-input-switch-switch--catalog\&viewMode=story\&globals=colorScheme:dark)

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

## Контролируемое состояние

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

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

export const NotificationsPreference = () => {
  const switchId = useId();
  const [checked, setChecked] = useState(false);

  return (
    <label
      htmlFor={switchId}
      style={{ display: 'inline-flex', alignItems: 'center', gap: 8 }}
    >
      <Switch
        id={switchId}
        name="notifications"
        checked={checked}
        onCheckedChange={setChecked}
      />
      <Text render={<span />}>Email notifications</Text>
    </label>
  );
};
```

`onCheckedChange` получает следующее булево значение и сведения о событии. Свойство `size` принимает `sm` или `md`; по умолчанию используется `md`.

Для единообразной полноширинной строки со значком, описанием и переключателем используйте [SettingsRow](https://docs.twenty.com/ru/ui/components/settings/settings-row.md).

## Клавиатура и формы

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

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

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

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

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

export const CustomPreference = () => (
  <Switch.Root aria-label="Updates" defaultChecked>
    <Switch.Thumb></Switch.Thumb>
  </Switch.Root>
);
```

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

Thumb получает текущее состояние checked, disabled, readOnly, required и Field. Его положение следует направлению чтения.

**Light**

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

**Dark**

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

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

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

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

## Свойства

Справочник включает свойства Base UI, специфичные для компонента и унаследованные. Также поддерживаются нативные атрибуты, такие как `aria-label` и `data-*`.

**checked** `boolean`

Whether the switch is currently active.

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

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

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

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

Whether the switch is initially active.

To render a controlled switch, 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 switch is rendered outside the form.

**id** `string`

The id of the hidden input element.

When `nativeButton` is `true`, the id is applied to the root element.

**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 switch is activated or deactivated.

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

Whether the user should be unable to activate or deactivate the switch.

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

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 activate the switch before submitting a form.

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

Visual size of the switch.

**style** `CSSProperties | ((state: SwitchRootState) =\> 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 switch is off.
By default, unchecked switches do not submit any value, matching native checkbox behavior.

**value** `string`

The value submitted with the form when the switch is on.
By default, switch submits the "on" value, matching native checkbox behavior.

### Switch.Root

**Root.checked** `boolean`

Whether the switch is currently active.

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

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

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

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

Whether the switch is initially active.

To render a controlled switch, 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 switch is rendered outside the form.

**Root.id** `string`

The id of the hidden input element.

When `nativeButton` is `true`, the id is applied to the root element.

**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 switch is activated or deactivated.

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

Whether the user should be unable to activate or deactivate the switch.

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

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 activate the switch before submitting a form.

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

Visual size of the switch.

**Root.style** `CSSProperties | ((state: SwitchRootState) =\> 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 switch is off.
By default, unchecked switches do not submit any value, matching native checkbox behavior.

**Root.value** `string`

The value submitted with the form when the switch is on.
By default, switch submits the "on" value, matching native checkbox behavior.

### Switch.Thumb

**Thumb.className** `string | ((state: SwitchThumbState) =\> string | undefined)`

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

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

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.

**Thumb.style** `CSSProperties | ((state: SwitchThumbState) =\> 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.