Espião de rolagem
Atualize automaticamente a navegação do Bootstrap ou os componentes do grupo de lista com base na posição de rolagem para indicar qual link está atualmente ativo na viewport.
Como funciona
Scrollspy alterna a .active
classe em elementos âncora ( <a>
) quando o elemento com o id
referenciado pela âncora href
é rolado para a visualização. Scrollspy é melhor usado em conjunto com um componente de navegação Bootstrap ou grupo de lista , mas também funcionará com qualquer elemento âncora na página atual. Aqui está como funciona.
-
Para começar, o scrollspy requer duas coisas: uma navegação, um grupo de listas ou um simples conjunto de links, além de um contêiner rolável. O contêiner rolável pode ser o
<body>
ou um elemento personalizado com um conjuntoheight
eoverflow-y: scroll
. -
No contêiner rolável, adicione
data-bs-spy="scroll"
edata-bs-target="#navId"
ondenavId
é o exclusivoid
da navegação associada. Certifique-se de incluir também umtabindex="0"
para garantir o acesso ao teclado. -
À medida que você rola o contêiner “espionado”, uma
.active
classe é adicionada e removida dos links de âncora na navegação associada. Os links devem terid
destinos resolvíveis, caso contrário, eles serão ignorados. Por exemplo, a<a href="#home">home</a>
deve corresponder a algo no DOM como<div id="home"></div>
-
Elementos de destino que não são visíveis serão ignorados. Consulte a seção Elementos não visíveis abaixo.
Exemplos
Barra de navegação
Role a área abaixo da barra de navegação e observe a mudança de classe ativa. Abra o menu suspenso e observe os itens suspensos serem destacados também.
Primeiro título
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Segundo título
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Terceiro título
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Quarto título
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Quinto título
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
<nav id="navbar-example2" class="navbar bg-light px-3 mb-3">
<a class="navbar-brand" href="#">Navbar</a>
<ul class="nav nav-pills">
<li class="nav-item">
<a class="nav-link" href="#scrollspyHeading1">First</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#scrollspyHeading2">Second</a>
</li>
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-expanded="false">Dropdown</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#scrollspyHeading3">Third</a></li>
<li><a class="dropdown-item" href="#scrollspyHeading4">Fourth</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#scrollspyHeading5">Fifth</a></li>
</ul>
</li>
</ul>
</nav>
<div data-bs-spy="scroll" data-bs-target="#navbar-example2" data-bs-root-margin="0px 0px -40%" data-bs-smooth-scroll="true" class="scrollspy-example bg-light p-3 rounded-2" tabindex="0">
<h4 id="scrollspyHeading1">First heading</h4>
<p>...</p>
<h4 id="scrollspyHeading2">Second heading</h4>
<p>...</p>
<h4 id="scrollspyHeading3">Third heading</h4>
<p>...</p>
<h4 id="scrollspyHeading4">Fourth heading</h4>
<p>...</p>
<h4 id="scrollspyHeading5">Fifth heading</h4>
<p>...</p>
</div>
Navegação aninhada
Scrollspy também funciona com .nav
s aninhados. Se um aninhado .nav
for .active
, seus pais também serão .active
. Role a área ao lado da barra de navegação e observe a mudança de classe ativa.
Item 1
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 1-1
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 1-2
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 2
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 3
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 3-1
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
Item 3-2
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Tenha em mente que o plugin JavaScript tenta escolher o elemento certo entre todos os que podem ser visíveis. Vários alvos de scrollspy visíveis ao mesmo tempo podem causar alguns problemas.
<div class="row">
<div class="col-4">
<nav id="navbar-example3" class="h-100 flex-column align-items-stretch pe-4 border-end">
<nav class="nav nav-pills flex-column">
<a class="nav-link" href="#item-1">Item 1</a>
<nav class="nav nav-pills flex-column">
<a class="nav-link ms-3 my-1" href="#item-1-1">Item 1-1</a>
<a class="nav-link ms-3 my-1" href="#item-1-2">Item 1-2</a>
</nav>
<a class="nav-link" href="#item-2">Item 2</a>
<a class="nav-link" href="#item-3">Item 3</a>
<nav class="nav nav-pills flex-column">
<a class="nav-link ms-3 my-1" href="#item-3-1">Item 3-1</a>
<a class="nav-link ms-3 my-1" href="#item-3-2">Item 3-2</a>
</nav>
</nav>
</nav>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#navbar-example3" data-bs-smooth-scroll="true" class="scrollspy-example-2" tabindex="0">
<div id="item-1">
<h4>Item 1</h4>
<p>...</p>
</div>
<div id="item-1-1">
<h5>Item 1-1</h5>
<p>...</p>
</div>
<div id="item-1-2">
<h5>Item 1-2</h5>
<p>...</p>
</div>
<div id="item-2">
<h4>Item 2</h4>
<p>...</p>
</div>
<div id="item-3">
<h4>Item 3</h4>
<p>...</p>
</div>
<div id="item-3-1">
<h5>Item 3-1</h5>
<p>...</p>
</div>
<div id="item-3-2">
<h5>Item 3-2</h5>
<p>...</p>
</div>
</div>
</div>
</div>
Listar grupo
Scrollspy também funciona com .list-group
s. Role a área ao lado do grupo de lista e observe a mudança de classe ativa.
Item 1
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 2
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 3
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 4
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
<div class="row">
<div class="col-4">
<div id="list-example" class="list-group">
<a class="list-group-item list-group-item-action" href="#list-item-1">Item 1</a>
<a class="list-group-item list-group-item-action" href="#list-item-2">Item 2</a>
<a class="list-group-item list-group-item-action" href="#list-item-3">Item 3</a>
<a class="list-group-item list-group-item-action" href="#list-item-4">Item 4</a>
</div>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#list-example" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
<h4 id="list-item-1">Item 1</h4>
<p>...</p>
<h4 id="list-item-2">Item 2</h4>
<p>...</p>
<h4 id="list-item-3">Item 3</h4>
<p>...</p>
<h4 id="list-item-4">Item 4</h4>
<p>...</p>
</div>
</div>
</div>
Âncoras simples
O Scrollspy não está limitado a componentes de navegação e grupos de listas, portanto, funcionará em qualquer <a>
elemento âncora no documento atual. Role a área e observe a .active
mudança de classe.
Item 1
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 2
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 3
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 4
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
Item 5
Este é um conteúdo de espaço reservado para a página do scrollspy. Observe que, à medida que você rola a página, o link de navegação apropriado é realçado. É repetido em todo o exemplo do componente. Continuamos adicionando mais alguns exemplos de cópia aqui para enfatizar a rolagem e o realce.
<div class="row">
<div class="col-4">
<div id="simple-list-example" class="d-flex flex-column gap-2 simple-list-example-scrollspy text-center">
<a class="p-1 rounded" href="#simple-list-item-1">Item 1</a>
<a class="p-1 rounded" href="#simple-list-item-2">Item 2</a>
<a class="p-1 rounded" href="#simple-list-item-3">Item 3</a>
<a class="p-1 rounded" href="#simple-list-item-4">Item 4</a>
<a class="p-1 rounded" href="#simple-list-item-5">Item 5</a>
</div>
</div>
<div class="col-8">
<div data-bs-spy="scroll" data-bs-target="#simple-list-example" data-bs-offset="0" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
<h4 id="simple-list-item-1">Item 1</h4>
<p>...</p>
<h4 id="simple-list-item-2">Item 2</h4>
<p>...</p>
<h4 id="simple-list-item-3">Item 3</h4>
<p>...</p>
<h4 id="simple-list-item-4">Item 4</h4>
<p>...</p>
<h4 id="simple-list-item-5">Item 5</h4>
<p>...</p>
</div>
</div>
</div>
Elementos não visíveis
Os elementos de destino que não estiverem visíveis serão ignorados e seus itens de navegação correspondentes não receberão uma .active
classe. As instâncias do Scrollspy inicializadas em um wrapper não visível ignorarão todos os elementos de destino. Use o refresh
método para verificar elementos observáveis quando o wrapper se tornar visível.
document.querySelectorAll('#nav-tab>[data-bs-toggle="tab"]').forEach(el => {
el.addEventListener('shown.bs.tab', () => {
const target = el.getAttribute('data-bs-target')
const scrollElem = document.querySelector(`${target} [data-bs-spy="scroll"]`)
bootstrap.ScrollSpy.getOrCreateInstance(scrollElem).refresh()
})
})
Uso
Por atributos de dados
Para adicionar facilmente o comportamento do scrollspy à sua navegação na barra superior, adicione data-bs-spy="scroll"
ao elemento que você deseja espionar (geralmente, isso seria o <body>
). Em seguida, adicione o data-bs-target
atributo com o id
nome da classe ou do elemento pai de qualquer .nav
componente do Bootstrap.
<body data-bs-spy="scroll" data-bs-target="#navbar-example">
...
<div id="navbar-example">
<ul class="nav nav-tabs" role="tablist">
...
</ul>
</div>
...
</body>
Por JavaScript
const scrollSpy = new bootstrap.ScrollSpy(document.body, {
target: '#navbar-example'
})
Opções
Como as opções podem ser passadas por meio de atributos de dados ou JavaScript, você pode anexar um nome de opção a data-bs-
, como em data-bs-animation="{value}"
. Certifique-se de alterar o tipo de caso do nome da opção de “ camelCase ” para “ kebab-case ” ao passar as opções por meio de atributos de dados. Por exemplo, use data-bs-custom-class="beautifier"
em vez de data-bs-customClass="beautifier"
.
A partir do Bootstrap 5.2.0, todos os componentes oferecem suporte a um atributo experimental de dados reservados data-bs-config
que pode abrigar a configuração simples do componente como uma string JSON. Quando um elemento tem atributos data-bs-config='{"delay":0, "title":123}'
e data-bs-title="456"
, o valor final title
será 456
e os atributos de dados separados substituirão os valores fornecidos em data-bs-config
. Além disso, os atributos de dados existentes podem hospedar valores JSON como data-bs-delay='{"show":0,"hide":150}'
.
Nome | Modelo | Predefinição | Descrição |
---|---|---|---|
rootMargin |
corda | 0px 0px -25% |
Unidades válidas de rootMargin do Observador de interseção , ao calcular a posição de rolagem. |
smoothScroll |
boleano | false |
Permite a rolagem suave quando um usuário clica em um link que se refere aos observáveis do ScrollSpy. |
target |
string, elemento DOM | null |
Especifica o elemento para aplicar o plugin Scrollspy. |
threshold |
variedade | [0.1, 0.5, 1] |
IntersectionObserver entrada válida de limite, ao calcular a posição de rolagem . |
Opções obsoletas
Até a v5.1.3, usávamos as opções offset
& method
, que agora estão obsoletas e substituídas por rootMargin
. Para manter a compatibilidade com versões anteriores, continuaremos a analisar um determinado offset
, rootMargin
mas esse recurso será removido na v6 .
Métodos
Método | Descrição |
---|---|
dispose |
Destrói o scrollspy de um elemento. (Remove os dados armazenados no elemento DOM) |
getInstance |
Método estático para obter a instância scrollspy associada a um elemento DOM. |
getOrCreateInstance |
Método estático para obter a instância scrollspy associada a um elemento DOM ou para criar uma nova caso não tenha sido inicializada. |
refresh |
Ao adicionar ou remover elementos no DOM, você precisará chamar o método refresh. |
Aqui está um exemplo usando o método de atualização:
const dataSpyList = document.querySelectorAll('[data-bs-spy="scroll"]')
dataSpyList.forEach(dataSpyEl => {
bootstrap.ScrollSpy.getInstance(dataSpyEl).refresh()
})
Eventos
Evento | Descrição |
---|---|
activate.bs.scrollspy |
Este evento é acionado no elemento scroll sempre que uma âncora é ativada pelo scrollspy. |
const firstScrollSpyEl = document.querySelector('[data-bs-spy="scroll"]')
firstScrollSpyEl.addEventListener('activate.bs.scrollspy', () => {
// do something...
})