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

Skip 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.

Exemplo(s)

Desktop (100%)
Tablet - 768px
iPhone (iOS) - 390x844
Android - 360x800
Compartilhar URL
Mudar fundo
Abrir no StackBlitz
Tela cheia
HTML
Controles
JS
CSS
Console
Angular (Somente leitura)
React (Somente leitura)
Vue (Somente leitura)
Acessibilidade
Recolher controles e código
Formatar código
Resetar código para o estado inicial
Copiar para a área de transferência

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()

open

Atributoopen
DescriçãoControla se o skip link está aberto.
Tipoboolean
Valor padrãofalse

position

Atributoposition
DescriçãoDefine a posição do skip link na tela.
- 'top-left': Posicionado no canto superior esquerdo.
- 'top-center': Posicionado no centro superior.
- 'top-right': Posicionado no canto superior direito.
Tipo"top-center" | "top-left" | "top-right"
Valor padrão'top-left'

showItemCount

Atributoshow-item-count
DescriçãoExibe a contagem de itens no formato (1/4), (2/4), etc.
Quando true, cada item mostrará sua posição relativa ao total de itens.
Por padrão, é true para o modo simple e false para o modo compound.
Tipoboolean
Valor padrão---

variant

Atributovariant
DescriçãoDefine se o skip link apresenta um ou múltiplos itens visíveis.
- 'simple': Exibe apenas um item por vez.
- 'compound': Exibe uma lista com múltiplos itens.
Tipo"compound" | "simple"
Valor padrão'compound'

zIndex

Atributoz-index
DescriçãoDefine o z-index do componente.
Controla a ordem de empilhamento do componente na página.
Tiponumber
Valor padrãonull

Eventos

EventoDescriçãoDepreciaçãoPropagação
brDidHide Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.Use brSkipLinkHide.true
brDidShow Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.Use brSkipLinkShow.true
brSkipLinkHideEvento canônico emitido ao ocultar o componente.---true
brSkipLinkNavigateEvento canônico emitido quando um destino é ativado.---true
brSkiplinkNavigation Componente mantido por compatibilidade; prefira a alternativa indicada na documentação.Use brSkipLinkNavigate.true
brSkipLinkShowEvento canônico emitido ao exibir o componente.---true

Métodos

hide

DescriçãoOculta o componente programaticamente.
Assinaturahide() => Promise<void>
Parâmetros---

show

DescriçãoExibe o componente programaticamente.
Assinaturashow() => Promise<void>
Parâmetros---

CSS Shadow Parts

NomeDescrição
"container"Parte para o contêiner principal do componente skip-link, usada para estilização via ::part().

Dependências

Subcomponentes

Depende de

Gráfico