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

Header Link

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-header-link representa um link de navegação institucional no cabeçalho. Deve ser utilizado dentro de um <br-header-list> no slot links do <br-header>.

Visão Geral​

Link do br-header, dentro de um br-header-list no slot links. Informe o destino em href e o texto no conteúdo.

Em SPA, use navigation-mode="event" e trate brNavigate.

Propriedades​

customId​

Atributocustom-id
DescriçãoIdentificador único do componente.
Quando omitido, um valor é gerado automaticamente.

> Padrão: valor único gerado por generateUniqueId().
Tipostring
Valor padrãogenerateUniqueId()

href​

Atributohref
DescriçãoURL do link.
Tipostring
Valor padrão---
Atributonavigation-mode
DescriçãoControla como o componente integra a navegação mantendo href real no elemento navegável.
- native (padrão): preserva o comportamento do navegador, conforme HTML/W3C.
- event: emite brNavigate; se o evento for cancelado, bloqueia a navegação nativa para a SPA assumir.
Cliques com modificadores, botão do meio ou target diferente de _self permanecem nativos.
Tipo"event" | "native"
Valor padrão'native'

target​

Atributotarget
DescriçãoDefine o alvo do link quando href está presente. Pode ser:
- _blank para abrir em uma nova aba,
- _self para abrir na mesma aba,
- _parent para abrir na aba pai,
- _top para abrir na aba superior.
Tipo"_blank" | "_parent" | "_self" | "_top"
Valor padrão'_self'

Slots​

NomeDescrição
"default"Slot para o conteúdo do link exibido no cabeçalho.

Eventos​

EventoDescriçãoDepreciaçãoPropagação
brNavigateEvento cancelável emitido em navigation-mode="event" para cliques primários sem modificadores em links _self. Chame event.preventDefault() no listener para impedir a navegação nativa e entregar event.detail.href ao roteador da SPA.---true

Migração da navegação​

Troque is-spa-link-behavior por navigation-mode="event" e trate brNavigate.

<!-- Antes -->
<br-header-link href="/orgaos" is-spa-link-behavior>Órgãos</br-header-link>

<!-- Agora -->
<br-header-link href="/orgaos" navigation-mode="event">Órgãos</br-header-link>

Dependências​

Componente pai​

Depende de​

Gráfico​

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