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

> Seleziona opzioni indipendenti con stati selezionato e indeterminato.

## Panoramica

Usa `Checkbox` quando ogni opzione può essere selezionata indipendentemente. Per una scelta mutuamente esclusiva, usa [RadioGroup](https://docs.twenty.com/it/ui/primitives/input/radio-group.md).

**Light**

[Esempio di casella di controllo (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--display\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Esempio di casella di controllo (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)

## Utilizzo

### Stato non controllato

Usa `defaultChecked` per impostare lo stato iniziale della selezione. La casella di controllo gestisce le modifiche successive.

```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>
  );
};
```

Una casella di controllo selezionata e con nome contribuisce con il proprio valore a un modulo. Imposta `uncheckedValue` se il modulo deve inviare un valore anche quando non è selezionata.

## Aspetto e interazione

Confronta gli stati selezionato, indeterminato e disabilitato, quindi scegli in modo indipendente colore, dimensione, forma e variante. Gli esempi abilitati possono essere attivati o disattivati.

**Light**

[Aspetto e interazione per la casella di controllo (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--catalog\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Aspetto e interazione per la casella di controllo (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)

| Proprietà | Valori | Predefinito |
| - | - | - |
| `dimensione` | `sm`, `md` | `sm` |
| `variant` | `solid`, `outline`, `soft` | `solid` |
| `shape` | `square`, `round` | `square` |
| `colore` | `accent`, `success`, `warning` | `accent` |

Tab porta il focus sulla casella di controllo e Spazio ne cambia lo stato. Facendo clic sulla relativa etichetta ne cambia anch'esso lo stato. Usa `disabled` per impedire l'interazione oppure `readOnly` quando il valore deve rimanere invariato mantenendo il controllo selezionabile tramite focus. Mantieni il significato nell'etichetta anziché comunicarlo solo tramite il colore.

## Stato controllato

Passa `checked` e aggiornalo con `onCheckedChange` per gestire la stessa preferenza nello stato di React. Il callback riceve il valore booleano successivo e i dettagli dell'evento.

```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>
  );
};
```

## Stato indeterminato

Una casella di controllo indeterminata rappresenta una selezione parziale. Derivalo dalle opzioni figlie indipendentemente dallo stato selezionato della casella di controllo.

```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>
  );
};
```

## Parti e contenuti personalizzati

`Checkbox` assembla la radice con stile e le relative icone di selezione e stato indeterminato predefinite. Usa `Checkbox.Root` con `Checkbox.Indicator` per gestire il contenuto dell'indicatore. Root gestisce lo stato e l'aspetto della casella; Indicator esegue il rendering del contenuto fornito.

```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` e `CheckboxIndicatorProps` sono tipi pubblici esportati da `twenty-ui/primitives/input`. Entrambe le parti accettano attributi nativi, gestori, ref, `render` e callback `className` e `style` basate sullo stato. Il `ref` di Root punta al controllo visibile; `inputRef` punta all'input nativo. Il ref della parte punta al relativo elemento renderizzato. Passa `nativeButton` con `render={<button />}` quando sostituisci Root con un pulsante. Le props dell'aspetto appartengono a Root; classi e stili espliciti vengono uniti a quelli predefiniti.

Indicator riceve lo stato selezionato e indeterminato, incluso lo stato di transizione. Imposta `keepMounted` per mantenere nel DOM un indicatore non selezionato; lo stile predefinito lo nasconde tramite opacità. Sovrascrivi il relativo `style` o `className` per transizioni personalizzate.

**Light**

[Composizione delle parti di Checkbox (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-parts--composition\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Composizione delle parti di 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)

L'assembly richiamabile e il relativo tipo `CheckboxProps` rimangono supportati. Sostituisci l'assembly con Root e la relativa parte quando fornisci icone personalizzate, anziché aggiungere un'altra parte ai figli dell'assembly.

Per il ripristino di un modulo controllato, gestisci `onReset` del modulo e ripristina `checked` al valore iniziale. Base UI 1.8 non ripristina lo stato dei componenti non controllati al ripristino nativo del modulo. `required`, `form`, `value` e `uncheckedValue` mantengono il comportamento dell'input nativo upstream.

## Props

Il riferimento viene generato dai tipi pubblici del componente. Gli attributi nativi, inclusi i nomi accessibili e i gestori degli eventi, sono accettati anche nelle parti che eseguono il rendering degli elementi.

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