Checkgroup

Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.

Anatomia, uso, comportamento visual e recomendações conceituais são mantidos pelo Padrão Digital de Governo. Esta página documenta a implementação Web Components e sua API executável.

Propriedades

customId

Atributo	custom-id
Descrição	Identificador legado do controlador.
Tipo	string
Valor padrão	---

disabled

Atributo	disabled
Descrição	Desabilita o controlador e os checkboxes contidos no grupo.
Tipo	boolean
Valor padrão	false

indeterminate

Atributo	indeterminate
Descrição	Estado indeterminado inicial.
Tipo	boolean
Valor padrão	false

label

Atributo	label
Descrição	Texto descritivo do grupo.
Tipo	string
Valor padrão	---

labelDesselecionado Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.

Atributo	label-desselecionado
Depreciação	Use selectAllLabel.
Descrição	Rótulo legado para marcar todos.
Tipo	string
Valor padrão	---

labelSelecionado Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.

Atributo	label-selecionado
Depreciação	Use unselectAllLabel.
Descrição	Rótulo legado para desmarcar todos.
Tipo	string
Valor padrão	---

selectAllLabel

Atributo	select-all-label
Descrição	Rótulo para marcar todos.
Tipo	string
Valor padrão	---

unselectAllLabel

Atributo	unselect-all-label
Descrição	Rótulo para desmarcar todos.
Tipo	string
Valor padrão	---

Slots

Nome	Descrição
"default"	Slot para adicionar os checkboxes controlados pelo grupo.

[Descontinuado/Obsoleto] Use br-checkbox-group.

Eventos nativos

O grupo não tem valor próprio. Os eventos input e change vêm de cada br-checkbox e chegam ao grupo por propagação; event.target é o checkbox alterado.

document.querySelector('br-checkgroup').addEventListener('change', (event) => {
  console.log(event.target.value, event.target.checked);
});

Para ler todas as escolhas, use FormData no formulário.

Dependências

Depende de

• br-checkbox-group

Gráfico