UI

Checkbox

Caixa de marcação para aceitar termos, ativar uma opção ou escolher vários itens de uma lista.

Instalação

npx shadcn@latest add @lenstech/checkbox

Uso

import { Checkbox, CheckboxGroup } from "@/components/ui/checkbox"
<Checkbox name="lgpd" isRequired>
  Aceito a Política de Privacidade
</Checkbox>

onChange recebe um boolean

onChange entrega true/false (e não o evento). Para controlar, use isSelected + onChange; para valor inicial, defaultSelected. Em um CheckboxGroup, o grupo controla a seleção com value (array de strings).

Exemplos

Com descrição

Seus dados serão usados apenas para retornar o contato, conforme a LGPD.

Desabilitado

Obrigatório

Com isRequired dentro de um Form, o envio é bloqueado até marcar. Tente enviar sem marcar.

Grupo

CheckboxGroup junta várias opções sob um rótulo. Cada Checkbox precisa de value. Use orientation="horizontal" para opções curtas.

Quais serviços interessam?Selecione quantos quiser.
Dias de atendimento

Selecionar todos (indeterminado)

isIndeterminate mostra um traço quando só parte dos itens está marcada.

Quando usar

  • Use para aceites (termos, LGPD) e para escolher várias opções de uma lista curta.
  • Não use para escolher uma opção entre várias — use Radio Group.
  • Não use para configurações com efeito imediato (sem botão de salvar) — use Switch.
  • Com muitas opções, prefira Select com selectionMode="multiple" ou List Box.

API

Checkbox

Aceita todas as props do Checkbox do React Aria, mais:

Prop

Type

CheckboxGroup

Aceita todas as props do CheckboxGroup do React Aria, mais:

Prop

Type

Composição

CheckboxField, CheckboxButton e CheckboxIndicator são as peças usadas pelo Checkbox. Use-as para layouts próprios (por exemplo, um checkbox dentro de um cartão).

On this page