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

# Caja de selección

> Seleccione opciones independientes con estados marcado e indeterminado.

## Resumen

Use `Checkbox` cuando cada opción pueda seleccionarse de forma independiente. Para una elección mutuamente excluyente, use [RadioGroup](https://docs.twenty.com/es/ui/primitives/input/radio-group.md).

**Light**

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

**Dark**

[Ejemplo de 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)

## "Uso"

### Estado no controlado

Usa `defaultChecked` para establecer el estado inicial de selección. La casilla de verificación controla los cambios posteriores.

```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 casilla de verificación marcada y con nombre aporta su valor a un formulario. Establezca `uncheckedValue` si el formulario también debe enviar un valor cuando esté desmarcada.

## Apariencia e interacción

Compare los estados seleccionado, indeterminado y deshabilitado y, a continuación, elija el color, el tamaño, la forma y la variante de forma independiente. Los ejemplos habilitados se pueden alternar.

**Light**

[Apariencia e interacción de la casilla de verificación (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-checkbox--catalog\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Apariencia e interacción de la casilla de verificación (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)

| Prop | Valores | Predeterminado |
| - | - | - |
| `tamaño` | `sm`, `md` | `sm` |
| `variant` | `solid`, `outline`, `soft` | `solid` |
| `shape` | `square`, `round` | `square` |
| `color` | `accent`, `success`, `warning` | `accent` |

Tab enfoca la casilla de verificación y Espacio cambia su estado. Al hacer clic en su etiqueta también cambia su estado. Use `disabled` para impedir la interacción, o `readOnly` cuando el valor deba permanecer sin cambios mientras el control siga pudiendo enfocarse. Mantenga el significado en la etiqueta en lugar de comunicarlo solo mediante el color.

## Estado controlado

Pasa `checked` y actualízalo con `onCheckedChange` para controlar la misma preferencia en el estado de React. La devolución de llamada recibe el siguiente valor booleano y los detalles del 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>
  );
};
```

## Estado indeterminado

Una casilla de verificación indeterminada representa una selección parcial. Derívalo de las opciones secundarias independientemente del estado de selección de la casilla de verificación.

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

## Partes y contenido personalizado

`Checkbox` ensambla la raíz con estilo y sus iconos predeterminados de marcado e indeterminado. Usa `Checkbox.Root` con `Checkbox.Indicator` para controlar el contenido del indicador. Root controla el estado y la apariencia de la caja; Indicator renderiza el contenido que proporcionas.

```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` y `CheckboxIndicatorProps` son tipos públicos exportados desde `twenty-ui/primitives/input`. Ambas partes aceptan atributos nativos, controladores, refs, `render` y callbacks de `className` y `style` basadas en el estado. La `ref` de Root apunta al control visible; `inputRef` apunta al input nativo. La ref de la parte apunta a su elemento renderizado. Pasa `nativeButton` con `render={<button />}` al reemplazar Root por un botón. Las props de apariencia pertenecen a Root; las clases y estilos explícitos se combinan con los predeterminados.

Indicator recibe el estado marcado e indeterminado, incluido el estado de transición. Establece `keepMounted` para conservar un indicador no marcado en el DOM; el estilo predeterminado lo oculta con opacidad. Anula su `style` o `className` para transiciones personalizadas.

**Light**

[Composición de partes de Checkbox (light)](https://storybook.twenty.com/iframe.html?id=ui-input-checkbox-parts--composition\&viewMode=story\&globals=colorScheme:light)

**Dark**

[Composición de partes de 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)

El ensamblaje invocable y su tipo `CheckboxProps` siguen siendo compatibles. Reemplaza el ensamblaje por Root y su parte al proporcionar iconos personalizados, en lugar de añadir otra parte a los elementos hijos del ensamblaje.

Para el restablecimiento controlado de formularios, controla el `onReset` del formulario y restaura `checked` a tu valor inicial. Base UI 1.8 no restaura el estado de componentes no controlados al restablecer formularios de forma nativa. `required`, `form`, `value` y `uncheckedValue` mantienen el comportamiento del input nativo subyacente.

## "Props"

La referencia se genera a partir de los tipos de componentes públicos. Los atributos nativos, incluidos los nombres accesibles y los manejadores de eventos, también se aceptan en las partes que representan elementos.

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