# Checkbox

Component Type

Como padrão, o checkbox (caixa de seleção) inclui o estado selecionado e não selecionado.Podemos utilizar checkbox nos seguintes casos:

  • Selecionar múltiplos itens em uma lista
  • Como filtro em uma página
  • Concordar com termos e condições de uso
  • Lista com subseções
Opções

# Props

Prop name Description Type Default Type format
color Cor do checkbox string 'var(--black-300)'
disabled Desabilita o checkbox boolean undefined
hideDetails Flag para Ocultar erros de dica e validação. Quando definido como auto, as mensagens serão renderizadas apenas se houver(dica, mensagem de erro, valor do contador, etc.) boolean false
indeterminateIcon Icone do checkbox quando estiver em estado indeterminado string '$indeterminate_check_box_rounded'
label Denfine a label do checkbox string undefined
offIcon Icone do checkbox quando estiver desmarcado string '$check_box_outline_blank_rounded'
onIcon Icone do checkbox quando estiver marcado string '$check_box_rounded'
small Flag para utilizar a variação pequena do componente boolean false
value Valor do checkbox boolean false

# Events

Event name Properties Description
change value Boolean - Valor atual do checkbox Evento emitido ao interagir com o checkbox

# Slots

Name Description Bindings
append Slot para adição de um elemento em frente o checkbox
label Slot para customização da label do checkbox
prepend Slot para adição de um elemento atrás do checkbox
default Slot padrão do componente