Checkbox

Um componente de seleção para ativar ou desativar uma opção.

Utilização


index.tsx
import { Checkbox } from "@convertcompany/ui";

Exemplos


Com Descrição


Customizando o ícone

Você pode substituir o ícone padrão passando o elemento na prop icon.


Props

Esse componente extende a implementação do Radix UI, e por isso, possui as mesmas propriedades. Para mais detalhes, consulte a documentação oficial.

PropriedadeTipo
variantEstilo visual do checkbox.
default
iconÍcone exibido quando o checkbox está selecionado.
ReactNode
checkedEstado de seleção do checkbox.
boolean
defaultCheckedEstado de seleção padrão do checkbox.
boolean
onCheckedChangeFunção chamada quando o estado de seleção muda.
(checked: boolean) => void
requiredIndica se o checkbox é obrigatório.
boolean
classNameClasse CSS adicional para customização.
string
...propsDemais props nativas do componente
CheckboxPrimitive.Root