checked

boolean

• false (default)

• true

Use true para inicializar o componente com um valor determinado mantendo o componente controlado.

customProps

{checkbox?: ComponentPropsWithRef<'span'>; input?: ComponentPropsWithRef<'input'>;}

Adiciona propriedades específicas para elementos filhos.

defaultChecked

boolean

• false (default)

• true

Use true para deixar com um valor inicial mas fazendo o componente não ser controlado onde as atualizações subsequentes ficam sem controle.

disabled

boolean

• false (default)

• true

Quando verdadeiro previne os usuários interagirem com o checkbox.

error

boolean

• false (default)

• true

Use true adicionar estilo de error no checkbox.

indeterminate

boolean

• false

• true

Se verdadeiro, o componente vai atualizar seu estado para indeterminado adicionando o valor de misto para o atributo aria-checked. Esse valor é utilizado quando alguns campos estão assinalados e outros não. Tabela de atributos para checkbox com 3 estados.

label

string

• -

Label para descrever o Checkbox

name

string

• -

Nome do campo do elemento, usado no envio do formulário HTML.

required

boolean

• false (default)

• true

Se true seu valor deve ser preenchido para submeter o formulário.

value

string

• -

Valor enviado através do nome do campo de formulário.

onChange

function

Função chamada quando o componente é alterado.

event é o objeto de evento do change.