Ir para o conteúdo principal
WBC - GovBR-DS
Copiar página como Markdown para IA

Cookiebar Group

Componente estável e recomendada para novos projetos.
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.
Subcomponente de Composição

O br-cookiebar-group agrupa cookies por finalidade com controle de seleção (switch ou checkbox). Deve ser inserido no corpo de configuração do componente orquestrador <br-cookiebar>.

Interação por teclado​

O cabeçalho expansível do br-cookiebar-group é um botão acessível por Tab. Enter ou Espaço expande ou recolhe o grupo. O controle de seleção do grupo (checkbox ou switch) é independente e mantém o próprio teclado nativo.

No fluxo padrão, o grupo é composto dentro de br-cookiebar, que gerencia o foco conforme mode e scrim.

Visão Geral​

Uma categoria de cookies dentro do br-cookiebar, como "Necessários" ou "Estatísticas". Contém um br-cookiebar-cookie para cada cookie.

Informe group-id, group-name e group-text. Use group-opt-out="false" quando a categoria não puder ser desativada: ela aparece como "Sempre ativo".

Propriedades​

alwaysActiveLabel​

Atributoalways-active-label
DescriçãoTexto exibido no lugar do checkbox quando group-opt-out="false".
Tipostring
Valor padrão'Sempre ativo'

customId​

Atributocustom-id
DescriçãoID interno gerado automaticamente. Não é necessário informar.
Tipostring
Valor padrãogenerateUniqueId()

expanded​

Atributoexpanded
DescriçãoControla se a lista de cookies está visível.
Tipoboolean
Valor padrãofalse

groupAlertMessage​

Atributogroup-alert-message
DescriçãoMensagem exibida quando o grupo é desmarcado, alertando sobre o impacto.
Tipostring
Valor padrão---

groupId​

Atributogroup-id
DescriçãoIdentificador único do grupo. Usado internamente para montar o JSON de resposta. (obrigatório)
Tipostring
Valor padrão---

groupName​

Atributogroup-name
DescriçãoNome exibido no cabeçalho do grupo (ex: Desempenho, Marketing). (obrigatório)
Tipostring
Valor padrão---

groupOptOut​

Atributogroup-opt-out
DescriçãoIndica se o usuário pode desativar este grupo de cookies.
- true (padrão): exibe checkbox e permite desativar.
- false: exibe "Sempre ativo" e não permite desativar.
Tipoboolean
Valor padrãotrue

groupSelected​

Atributogroup-selected
DescriçãoEstado de seleção do checkbox do grupo.
Pode ser controlado externamente pelo br-cookiebar (propagação top-down)
ou recalculado automaticamente a partir do estado dos cookies filhos (bottom-up).
Tipoboolean
Valor padrãofalse

groupText​

Atributogroup-text
DescriçãoTexto descritivo exibido abaixo do cabeçalho, explicando a finalidade do grupo. (obrigatório)
Tipostring
Valor padrão---

selectAllGroupLabel​

Atributoselect-all-group-label
DescriçãoTexto do checkbox quando o grupo está totalmente selecionado (ação: desselecionar).
Tipostring
Valor padrão'Selecionar toda classe'

unselectAllGroupLabel​

Atributounselect-all-group-label
DescriçãoTexto do checkbox quando o grupo está desmarcado ou indeterminado (ação: selecionar).
Tipostring
Valor padrão'Desselecionar toda classe'

Slots​

NomeDescrição
"default"Recebe os subcomponentes br-cookiebar-cookie do grupo.

Eventos​

EventoDescriçãoDepreciaçãoPropagação
brCookiebarGroupChangeEmitido quando o estado de seleção do grupo muda (por interação do usuário ou propagação). O br-cookiebar pai escuta este evento para recalcular o checkbox "Selecionar todos".---true
brCookiebarGroupToggleEmitido ao expandir ou recolher a lista de cookies do grupo.---true

Métodos​

getState​

DescriçãoRetorna o estado atual de seleção do grupo:
- true: todos os cookies opt-out estão selecionados.
- false: nenhum cookie opt-out está selecionado.
- 'indeterminate': seleção parcial.
AssinaturagetState() => Promise<CookiebarSelectionState>
Parâmetros---

CSS Shadow Parts​

NomeDescrição
"body"Área expansível que contém os cookies.
"container"Div raiz do grupo.
"header"Linha de cabeçalho com nome, contadores e controles.

Dependências​

Componente pai​

Depende de​

Gráfico​

Comece aquiComponentesQuickstartsSobre o projetoRepositório GitLabVersõesDiscordGovBR-DSFAQWikiRedefinir cookies