Cookiebar Cookie

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-cookie detalha as especificações de um cookie individual (nome, fornecedor, validade, finalidade). Deve ser utilizado exclusivamente dentro de um <br-cookiebar-group> no <br-cookiebar>.

Visão Geral

O componente br-cookiebar-cookie é o subcomponente do GovBR-DS que descreve as especificações técnicas de um cookie individual.

Para que serve

• Transparência técnica: Detalha nome, validade, finalidade e fornecedor do cookie.
• Esclarecimento ao cidadão: Oferece visibilidade granular sobre cada elemento de persistência.

Papel na composição

Atua como item folha descritivo na listagem de cookies.

Regra de uso e relacionamento

• Deve ser utilizado exclusivamente dentro de um br-cookiebar-group.
• Não deve ser utilizado fora do ecossistema de gestão de cookies.

Propriedades

alertMessage

Atributo	alert-message
Descrição	Mensagem exibida quando o switch é desligado, alertando sobre o impacto.
Tipo	string
Valor padrão	---

cookieId

Atributo	cookie-id
Descrição	Identificador único do cookie. Usado internamente para montar o JSON de resposta. (obrigatório)
Tipo	string
Valor padrão	---

cookieName

Atributo	cookie-name
Descrição	Nome do cookie. (obrigatório)
Tipo	string
Valor padrão	---

cookieNameLabel

Atributo	cookie-name-label
Descrição	Rótulo do item "nome do cookie" na lista.
Tipo	string
Valor padrão	'Cookies'

cookieOptOut

Atributo	cookie-opt-out
Descrição	Indica se o usuário pode desativar este cookie. - true (padrão): exibe o switch e permite desativar. - false: o cookie é sempre ativo e o switch não aparece.
Tipo	boolean
Valor padrão	true

cookieSelected

Atributo	cookie-selected
Descrição	Estado atual do switch: ligado ou desligado.
Tipo	boolean
Valor padrão	false

customId

Atributo	custom-id
Descrição	ID interno gerado automaticamente. Não é necessário informar.
Tipo	string
Valor padrão	generateUniqueId()

description

Atributo	description
Descrição	Descrição detalhada do cookie e como ele é utilizado. (obrigatório)
Tipo	string
Valor padrão	---

descriptionLabel

Atributo	description-label
Descrição	Rótulo do item "descrição" na lista.
Tipo	string
Valor padrão	'Descrição'

domain

Atributo	domain
Descrição	Domínio ao qual o cookie pertence (ex: serpro.gov.br). (obrigatório)
Tipo	string
Valor padrão	---

domainLabel

Atributo	domain-label
Descrição	Rótulo do item "domínio" na lista.
Tipo	string
Valor padrão	'Domínio'

enterprise

Atributo	enterprise
Descrição	Nome da empresa responsável pelo cookie (ex: Serpro, Google). (obrigatório)
Tipo	string
Valor padrão	---

enterpriseLabel

Atributo	enterprise-label
Descrição	Rótulo do item "empresa" na lista.
Tipo	string
Valor padrão	'Empresa'

expires

Atributo	expires
Descrição	Tempo de vida do cookie (ex: 30 minutos, 1 ano, Sessão). (obrigatório)
Tipo	string
Valor padrão	---

expiresLabel

Atributo	expires-label
Descrição	Rótulo do item "vencimento" na lista.
Tipo	string
Valor padrão	'Vencimento'

extraLabel

Atributo	extra-label
Descrição	Rótulo de um campo extra opcional exibido ao final da lista de itens. Use junto com extra-value para adicionar uma informação personalizada sem precisar usar o slot.
Tipo	string
Valor padrão	---

extraValue

Atributo	extra-value
Descrição	Valor do campo extra. Exibido ao lado do extra-label.
Tipo	string
Valor padrão	---

offLabel

Atributo	off-label
Descrição	Texto exibido no switch quando está desligado.
Tipo	string
Valor padrão	'Desligado'

purpose

Atributo	purpose
Descrição	Para que serve este cookie (ex: Autenticação, Análise de tráfego). (obrigatório)
Tipo	string
Valor padrão	---

purposeLabel

Atributo	purpose-label
Descrição	Rótulo do item "finalidade" na lista.
Tipo	string
Valor padrão	'Finalidade'

switchOnLabel

Atributo	on-label
Descrição	Texto exibido no switch quando está ligado.
Tipo	string
Valor padrão	'Ligado'

Slots

Nome	Descrição
"default"	Área livre para inserir conteúdo personalizado abaixo dos itens do cookie.

Eventos

Evento	Descrição	Depreciação	Propagação
brCookiebarCookieChange	Emitido ao ligar/desligar o switch. Borbulha até o br-cookiebar-group pai para recalcular o estado do grupo.	---	true

CSS Shadow Parts

Nome	Descrição
"card"	Container principal do cookie.
"details"	Wrapper interno com o switch, alerta e lista de itens.
"switch"	Área que contém o switch de ativação.

Dependências

Componente pai

• br-cookiebar

Depende de

• br-switch
• br-message

Gráfico