CheckboxCard
Avisos de vencimento
Sozinho
import { CheckboxCard } from '@rivocode/ui'Quando usar
Opção em cartão que se marca e desmarca: avisos, módulos do plano, adicionais.
É um Checkbox inteiro dentro de um cartão, com title, description e
icon, como o RadioCard. O cartão todo é o alvo, o title é o nome falado e
a description é a descrição da caixa. Marcado, a borda vai para o acento, e
a caixa com o tique continua lá.
Dentro de um CheckboxGroup, cada cartão leva o value e o grupo guarda a
lista marcada. Sozinho, ele fala checked e onCheckedChange, como o
Checkbox.
<CheckboxGroup aria-label="Avisos de vencimento" defaultValue={["email"]}>
<CheckboxCard value="email" title="E-mail" description="Um resumo por dia, às 8h." />
<CheckboxCard value="sms" title="SMS" description="Só o que vence hoje." />
</CheckboxGroup>
className veste o cartão, e classNames alcança card, control, icon,
title e description, os mesmos nomes do RadioCard.
Quando não usar
Quando só uma opção vale, é RadioCard: caixa de marcar promete que dá para
somar. Liga e desliga que vale na hora, sem botão de salvar, é Switch. E a
lista de opções curtas, sem nada a explicar, fica menor e mais rápida de ler
como Checkbox no CheckboxGroup.
No React Native
Traduz pelo nome e pelas partes do web: title, description, icon, indeterminate, disabled, invalid e classNames (card, control, icon, title, description). É controlado por checked e onCheckedChange, como o Checkbox nativo, e o cartão inteiro é o alvo do toque, com papel checkbox e o estado (mixed no indeterminado).
media é a área livre de cima, e só existe aqui. Até a 5.0 o cartão do nativo era só o desenho do item do CheckboxGroup variant="card", e não havia onde pôr um desenho grande: o icon cabe em 20pt, e escolher pelo desenho - a foto do produto, a amostra do tema - foi o pedido de um app real. media ocupa a largura do cartão, em cima do texto, e fica escondida do leitor de tela, que ouve o title.
Agrupe os cartões numa View e diga o nome do conjunto nela; o CheckboxGroup variant="card" continua sendo o atalho quando as opções vêm de uma lista e não precisam de desenho grande.
API
| Prop | Tipo | Padrão |
|---|---|---|
titleobrigatóriaO nome da opcao, em destaque: "Aviso por e-mail". | ReactNode | sem padrão |
checkedSe a caixa está marcada agora. | boolean | sem padrão |
classNamesClasse por parte: `card` (o cartao inteiro, que e o `<label>`), `control` (a caixa), `icon`, `title` e `description`. | Partial<Record<"card" | "control" | "description" | "icon" | "title", string>> | sem padrão |
defaultCheckedSe a caixa começa marcada. | boolean | false |
descriptionA letra miuda que ajuda a decidir: o que muda ao marcar. | ReactNode | sem padrão |
disabledSe a peça deve ignorar a interação do usuário. | boolean | false |
formIdentifica o formulário dono do campo oculto. | string | sem padrão |
iconO desenho a esquerda do texto, escondido do leitor de tela. | ReactNode | sem padrão |
indeterminateSe a caixa está no estado misto: nem marcada, nem desmarcada. | boolean | false |
inputRefUma ref para o `<input>` oculto. | Ref<HTMLInputElement> | sem padrão |
nameIdentifica o campo quando o formulário é enviado. | string | sem padrão |
nativeButtonSe a peça renderiza um `<button>` nativo quando é trocada pela prop `render`. | boolean | false |
onCheckedChangeChamado quando a caixa é marcada ou desmarcada. | ((checked: boolean, eventDetails: { reason: "none"; event: Event; cancel: () => void; allowPropagation: () => void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) => void) | sem padrão |
parentSe a caixa controla um grupo de caixas filhas. | boolean | false |
readOnlySe o usuário fica impedido de marcar ou desmarcar a caixa. | boolean | false |
renderTroca o elemento HTML da peça por outra tag, ou a compõe com outro componente. | ComponentRenderFn<HTMLProps, CheckboxRootState> | ReactElement<unknown, string | JSXElementConstructor<any>> | sem padrão |
requiredSe o usuário precisa marcar a caixa antes de enviar o formulário. | boolean | false |
uncheckedValueO valor enviado com o formulário quando a caixa está desmarcada. | string | sem padrão |
valueO valor da caixa. | string | sem padrão |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.