Header Function

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-function representa uma ação funcional ou atalho utilitário (ex.: contraste, acessibilidade). Deve ser utilizado dentro de um <br-header-list> no slot functions do <br-header>.

Visão Geral

Atalho do br-header, como contraste ou ajuda, dentro de um br-header-list no slot functions.

Coloque o ícone no slot icon e o nome no conteúdo:

<br-header-function href="/ajuda">
  <br-icon slot="icon" src="/icones/ajuda.svg"></br-icon>
  Ajuda
</br-header-function>

Em telas grandes, aparece como botão de ícone, e o nome é usado como texto acessível. Em telas menores, aparece com ícone e nome dentro do menu da lista.

Propriedades

customId

Atributo	custom-id
Descrição	Identificador único do componente. Quando omitido, um valor é gerado automaticamente. > Padrão: valor único gerado por generateUniqueId().
Tipo	string
Valor padrão	generateUniqueId()

href

Atributo	href
Descrição	URL de destino da funcionalidade.
Tipo	string
Valor padrão	---

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

Atributo	icon-name
Depreciação	Use o slot icon com um SVG, asset ou elemento de ícone controlado pela aplicação.
Descrição	Identificador legado do ícone exibido. Nomes conhecidos são resolvidos pelo registro SVG local; para novos usos, prefira o slot icon com um SVG, asset local ou elemento de ícone controlado pela aplicação.
Tipo	string
Valor padrão	null

navigationMode

Atributo	navigation-mode
Descrição	Controla 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

Atributo	target
Descrição	Define 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

Nome	Descrição
"default"	Slot para o nome ou rótulo da funcionalidade.
"icon"	Slot para ícone que representa a funcionalidade.

Eventos

Evento	Descrição	Depreciação	Propagação
brNavigate	Evento 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. Sem href, o atalho funciona como botão.

<!-- Antes -->
<br-header-function href="/notificacoes" is-spa-link-behavior>
  <br-icon slot="icon" src="/icones/sino.svg"></br-icon>
  Notificações
</br-header-function>

<!-- Agora -->
<br-header-function href="/notificacoes" navigation-mode="event">
  <br-icon slot="icon" src="/icones/sino.svg"></br-icon>
  Notificações
</br-header-function>

Dependências

Componente pai

• br-header

Depende de

• br-button
• br-icon
• br-item

Gráfico