Copiar página como Markdown para IA
Cookiebar Group
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>.
Visão Geral
O componente br-cookiebar-group é o subcomponente do GovBR-DS que representa uma categoria de cookies (ex.: necessários, desempenho, marketing) acompanhada de um controle de seleção (switch ou checkbox).
Para que serve
- Segmentação por finalidade: Organiza os cookies conforme o tipo e necessidade técnica.
- Controle de consentimento: Permite habilitar ou desabilitar categorias não obrigatórias.
Papel na composição
Atua como contêiner de agrupamento intermediário dentro do br-cookiebar, contendo instâncias de br-cookiebar-cookie.
Regra de uso e relacionamento
- Deve ser utilizado dentro do corpo de configuração do
br-cookiebar. - Recebe elementos filhos do tipo
br-cookiebar-cookie.
Propriedades
alwaysActiveLabel
| Atributo | always-active-label |
|---|---|
| Descrição | Texto exibido no lugar do checkbox quando group-opt-out="false". |
| Tipo | string |
| Valor padrão | 'Sempre ativo' |
customId
| Atributo | custom-id |
|---|---|
| Descrição | ID interno gerado automaticamente. Não é necessário informar. |
| Tipo | string |
| Valor padrão | generateUniqueId() |
expanded
| Atributo | expanded |
|---|---|
| Descrição | Controla se a lista de cookies está visível. |
| Tipo | boolean |
| Valor padrão | false |
groupAlertMessage
| Atributo | group-alert-message |
|---|---|
| Descrição | Mensagem exibida quando o grupo é desmarcado, alertando sobre o impacto. |
| Tipo | string |
| Valor padrão | --- |
groupId
| Atributo | group-id |
|---|---|
| Descrição | Identificador único do grupo. Usado internamente para montar o JSON de resposta. (obrigatório) |
| Tipo | string |
| Valor padrão | --- |
groupName
| Atributo | group-name |
|---|---|
| Descrição | Nome exibido no cabeçalho do grupo (ex: Desempenho, Marketing). (obrigatório) |
| Tipo | string |
| Valor padrão | --- |
groupOptOut
| Atributo | group-opt-out |
|---|---|
| Descrição | Indica 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. |
| Tipo | boolean |
| Valor padrão | true |
groupSelected
| Atributo | group-selected |
|---|---|
| Descrição | Estado 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). |
| Tipo | boolean |
| Valor padrão | false |
groupText
| Atributo | group-text |
|---|---|
| Descrição | Texto descritivo exibido abaixo do cabeçalho, explicando a finalidade do grupo. (obrigatório) |
| Tipo | string |
| Valor padrão | --- |
selectAllGroupLabel
| Atributo | select-all-group-label |
|---|---|
| Descrição | Texto do checkbox quando o grupo está totalmente selecionado (ação: desselecionar). |
| Tipo | string |
| Valor padrão | 'Selecionar toda classe' |
unselectAllGroupLabel
| Atributo | unselect-all-group-label |
|---|---|
| Descrição | Texto do checkbox quando o grupo está desmarcado ou indeterminado (ação: selecionar). |
| Tipo | string |
| Valor padrão | 'Desselecionar toda classe' |
Slots
| Nome | Descrição |
|---|---|
"default" | Recebe os subcomponentes br-cookiebar-cookie do grupo. |
Eventos
| Evento | Descrição | Depreciação | Propagação |
|---|---|---|---|
brCookiebarGroupChange | Emitido 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 |
brCookiebarGroupToggle | Emitido ao expandir ou recolher a lista de cookies do grupo. | --- | true |
Métodos
getState
| Descrição | Retorna 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. |
|---|---|
| Assinatura | getState() => Promise<CookiebarSelectionState> |
| Parâmetros | --- |
CSS Shadow Parts
| Nome | Descriçã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. |
