Ir al contenido

Checkbox

Componente de checkbox para seleccionar múltiples opciones con varios estilos y soporte de grupo.

import { Checkbox } from 'asterui'

Uso Básico

Checkbox simple con etiqueta.

import { Checkbox } from 'asterui'

function App() {
  return (
      <Checkbox>Accept terms and conditions</Checkbox>
    )
}

export default App

Colores

Diferentes colores de checkbox para varios contextos.

import { Checkbox, Space } from 'asterui'

function App() {
  return (
      <Space direction="vertical" size="sm">
        <Checkbox color="primary" defaultChecked>Primary</Checkbox>
        <Checkbox color="secondary" defaultChecked>Secondary</Checkbox>
        <Checkbox color="accent" defaultChecked>Accent</Checkbox>
        <Checkbox color="success" defaultChecked>Success</Checkbox>
        <Checkbox color="warning" defaultChecked>Warning</Checkbox>
        <Checkbox color="info" defaultChecked>Info</Checkbox>
        <Checkbox color="error" defaultChecked>Error</Checkbox>
      </Space>
    )
}

export default App

Tamaños

Cinco tamaños de checkbox desde xs hasta xl.

import { Checkbox, Space } from 'asterui'

function App() {
  return (
      <Space direction="horizontal" size="md" align="center">
        <Checkbox size="xs" defaultChecked>XS</Checkbox>
        <Checkbox size="sm" defaultChecked>SM</Checkbox>
        <Checkbox size="md" defaultChecked>MD</Checkbox>
        <Checkbox size="lg" defaultChecked>LG</Checkbox>
        <Checkbox size="xl" defaultChecked>XL</Checkbox>
      </Space>
    )
}

export default App

Deshabilitado

Estados de checkbox deshabilitado.

import { Checkbox, Space } from 'asterui'

function App() {
  return (
      <Space direction="horizontal" size="md">
        <Checkbox disabled>Disabled</Checkbox>
        <Checkbox disabled defaultChecked>Disabled Checked</Checkbox>
      </Space>
    )
}

export default App

Indeterminado

Estado indeterminado para funcionalidad de seleccionar todo.

import { Checkbox, Space } from 'asterui'
import { useState } from 'react'

function App() {
  const [items, setItems] = useState([true, false, true])
  const allChecked = items.every(Boolean)
  const someChecked = items.some(Boolean) && !allChecked
  
  const handleSelectAll = () => {
    setItems(allChecked ? [false, false, false] : [true, true, true])
  }
  
  return (
      <Space direction="vertical" size="sm">
        <Checkbox
          checked={allChecked}
          indeterminate={someChecked}
          onChange={handleSelectAll}
          className="font-medium"
        >
          Select All
        </Checkbox>
        <div className="ml-6">
          <Space direction="vertical" size="xs">
            {['Item 1', 'Item 2', 'Item 3'].map((item, i) => (
              <Checkbox
                key={i}
                checked={items[i]}
                onChange={() => {
                  const newItems = [...items]
                  newItems[i] = !newItems[i]
                  setItems(newItems)
                }}
              >
                {item}
              </Checkbox>
            ))}
          </Space>
        </div>
      </Space>
    )
}

export default App

Grupo de Checkbox

Agrupa múltiples checkboxes con estado compartido.

import { Checkbox, Modal } from 'asterui'

function App() {
  const options = [
    { label: 'Apple', value: 'apple' },
    { label: 'Banana', value: 'banana' },
    { label: 'Orange', value: 'orange' },
    { label: 'Mango', value: 'mango' },
  ]
  
  return (
      <Checkbox.Group
        options={options}
        defaultValue={['apple', 'orange']}
        onChange={(values) => Modal.info({ title: 'Selected', content: values.join(', ') })}
      />
    )
}

export default App

Grupo con Opciones

Genera checkboxes desde array de opciones con soporte de deshabilitado.

import { Checkbox } from 'asterui'

function App() {
  const options = [
    { label: 'Read', value: 'read' },
    { label: 'Write', value: 'write' },
    { label: 'Delete', value: 'delete', disabled: true },
  ]
  
  return (
      <Checkbox.Group
        options={options}
        defaultValue={['read']}
      />
    )
}

export default App

Dirección del Grupo

Diseños de grupo horizontal y vertical.

Horizontal (default)

Vertical

import { Checkbox, Space } from 'asterui'

function App() {
  const options = ['Option A', 'Option B', 'Option C']
  
  return (
      <Space direction="vertical" size="lg">
        <div>
          <p className="text-sm font-medium mb-2">Horizontal (default)</p>
          <Checkbox.Group options={options} direction="horizontal" defaultValue={['Option A']} />
        </div>
        <div>
          <p className="text-sm font-medium mb-2">Vertical</p>
          <Checkbox.Group options={options} direction="vertical" defaultValue={['Option B']} />
        </div>
      </Space>
    )
}

export default App

Controlado

Checkbox controlado con gestión de estado externa.

Checked: No

import { Checkbox, Space } from 'asterui'
import { useState } from 'react'

function App() {
  const [checked, setChecked] = useState(false)
  
  return (
      <Space direction="vertical" size="sm">
        <Checkbox
          checked={checked}
          onChange={(e) => setChecked(e.target.checked)}
        >
          Controlled checkbox
        </Checkbox>
        <p className="text-sm text-base-content/70">
          Checked: {checked ? 'Yes' : 'No'}
        </p>
      </Space>
    )
}

export default App

Modo Swap

Alterna entre dos estados visuales con efectos de animación.

import { Checkbox, Space } from 'asterui'
import { SpeakerWaveIcon, SpeakerXMarkIcon } from '@aster-ui/icons/solid'
import { useState } from 'react'

function App() {
  const [volume, setVolume] = useState(true)
  
  return (
      <Space size="lg">
        <Checkbox
          checked={volume}
          onChange={(e) => setVolume(e.target.checked)}
          swap={{
            on: <SpeakerWaveIcon size={32} />,
            off: <SpeakerXMarkIcon size={32} />,
          }}
        />
        <Checkbox
          swap={{
            on: <span className="text-2xl">😀</span>,
            off: <span className="text-2xl">😴</span>,
            effect: 'rotate',
          }}
        />
        <Checkbox
          swap={{
            on: <span className="text-xl font-bold text-success">ON</span>,
            off: <span className="text-xl font-bold text-error">OFF</span>,
            effect: 'flip',
          }}
        />
      </Space>
    )
}

export default App
PropiedadDescripciónTipoPredeterminado
checkedEstado marcado controladoboolean-
defaultCheckedEstado marcado predeterminadoboolean-
disabledDeshabilitar el checkboxbooleanfalse
indeterminateEstado indeterminado (selección parcial)booleanfalse
sizeTamaño del checkbox'xs' | 'sm' | 'md' | 'lg' | 'xl'-
colorColor del checkbox'primary' | 'secondary' | 'accent' | 'neutral' | 'success' | 'warning' | 'info' | 'error'-
swapConfiguración del modo swapCheckboxSwapConfig-
valueValor cuando se usa en un grupostring | number-
onChangeManejador de evento de cambio(e: ChangeEvent) => void-
nameAtributo name HTML para el inputstring-
autoFocusFoco automático al montarbooleanfalse
classNameClases CSS adicionalesstring-
childrenContenido de etiqueta (automáticamente envuelto en elemento label)ReactNode-
PropiedadDescripciónTipoPredeterminado
valueValores seleccionados controlados(string | number)[]-
defaultValueValores seleccionados predeterminados(string | number)[]-
onChangeCallback de cambio de selección(values: (string | number)[]) => void-
disabledDeshabilitar todos los checkboxesbooleanfalse
optionsOpciones de checkbox(string | number | CheckboxOptionType)[]-
directionDirección de diseño'horizontal' | 'vertical''vertical'
nameAtributo name HTML para todos los checkboxes (para envío de formulario)string-
childrenElementos de checkbox manualesReactNode-
PropiedadDescripciónTipoPredeterminado
onContenido mostrado cuando está marcadoReactNode-
offContenido mostrado cuando está desmarcadoReactNode-
effectEfecto de animación'rotate' | 'flip'-
PropiedadDescripciónTipoPredeterminado
labelEtiqueta de opciónReactNode-
valueValor de opciónstring | number-
disabledDeshabilitar esta opciónbooleanfalse
  • Usa input de checkbox nativo para soporte de teclado y lector de pantalla
  • Asocia correctamente las etiquetas con los checkboxes
  • El estado indeterminado se comunica mediante la propiedad nativa indeterminate
  • El estado deshabilitado previene la interacción y se comunica a tecnologías de asistencia
  • Los estados de foco son visibles para navegación por teclado