menu-link

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 do link. (obrigatório)
Tipo	string
Valor padrão	---

label

Atributo	label
Descrição	Texto canônico do link. Quando informado, tem precedência sobre titulo.
Tipo	string
Valor padrão	---

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	Destino do link.
Tipo	"_blank" | "_parent" | "_self" | "_top"
Valor padrão	'_self'

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

Atributo	titulo
Depreciação	Use label.
Descrição	Título do link (obrigatório)
Tipo	string
Valor padrão	---

Slots

Nome	Descrição
"icon"	Slot para ícone personalizado do link.
"url"	Slot para o texto exibido no link.

Eventos

Evento	Descrição	Depreciação	Propagação
brLinkClick Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.	Evento emitido quando o link externo é clicado.	Use brMenuLinkClick.	true
brMenuLinkClick	Evento canônico emitido quando o link externo é clicado.	---	true
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

CSS Shadow Parts

Nome	Descrição
"link"	Elemento âncora do link.

Dependências

Componente pai

• br-menu

Depende de

• br-icon

Gráfico

Migração de Navegação

Antes, br-menu-link usava url para o destino do link.

Agora, use href.

<!-- Antes -->
<br-menu-link url="/externo" titulo="Link externo"></br-menu-link>

<!-- Agora -->
<br-menu-link href="/externo" titulo="Link externo" navigation-mode="event"></br-menu-link>

O slot chamado url continua sendo apenas um slot de conteúdo visual legado. Ele não define mais o destino do link.

O contrato é igual ao dos demais links: native é o padrão; event emite brNavigate e só bloqueia a navegação quando o evento é cancelado. Modificadores, clique do meio e target diferente de _self permanecem nativos.