header-function

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.

Visão Geral

Para a documentação completa, incluindo diretrizes de uso, acessibilidade e exemplos visuais, consulte o Design System do GovBR.

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	Nome Iconify do ícone exibido.
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.

Dependências

Componente pai

• br-header

Depende de

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

Gráfico

Migração de Navegação

Antes, br-header-function encaminhava is-spa-link-behavior para o br-item interno.

Agora, use navigation-mode="event" quando href apontar para uma rota interna da SPA.

<!-- Antes -->
<br-header-function href="/notificacoes" is-spa-link-behavior
  ><i slot="icon" class="fa-solid fa-bell" aria-hidden="true"></i>Notificações</br-header-function
>

<!-- Agora -->
<br-header-function href="/notificacoes" navigation-mode="event"
  ><i slot="icon" class="fa-solid fa-bell" aria-hidden="true"></i>Notificações</br-header-function
>

Quando renderizado como ação sem link, o componente continua se comportando como botão.