Scrollspy
Aghjurnate automaticamente a navigazione Bootstrap o i cumpunenti di u gruppu di lista basatu nantu à a pusizione di scroll per indicà quale ligame hè attualmente attivu in a finestra di vista.
Cumu funziona
Scrollspy cambia a .active
classa nantu à l'elementi di l'ancora ( <a>
) quandu l'elementu cù u id
riferimentu da l'ancora href
hè scrollatu in vista. Scrollspy hè megliu utilizatu in cunghjunzione cù un cumpunente di navigazione Bootstrap o un gruppu di lista , ma ancu travaglià cù qualsiasi elementi di ancora in a pagina attuale. Eccu cumu si travaglia.
-
Per principià, scrollspy richiede duie cose: una navigazione, un gruppu di lista, o un set simplice di ligami, più un containeru scrollable. U cuntinuu scrollable pò esse u
<body>
o un elementu persunalizatu cù un setheight
èoverflow-y: scroll
. -
Nantu à u cuntinuu scrollable, aghjunghje
data-bs-spy="scroll"
èdata-bs-target="#navId"
induvenavId
hè l'unicuid
di a navigazione assuciata. Assicuratevi di include ancu untabindex="0"
per assicurà l'accessu à u teclatu. -
Mentre scorri u cuntinuu "spiatu", una
.active
classa hè aghjuntu è sguassata da i ligami d'ancora in a navigazione assuciata. I ligami devenu avèid
obiettivi risolvibili, altrimenti sò ignorati. Per esempiu, un<a href="#home">home</a>
deve currisponde à qualcosa in u DOM cum'è<div id="home"></div>
-
Elementi di destinazione chì ùn sò micca visibili seranu ignorati. Vede a rùbbrica Elementi micca visibili sottu.
Esempii
Navbar
Scroll the area below the navbar and watch the active class change. Apertura u menù drop-down è fighjate l'articuli drop-down esse evidenziati ancu.
Prima rubrica
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Seconda rubrica
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Terzu capu
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Quarta rubrica
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Quinta rubrica
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
<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>
Nav nidificatu
Scrollspy travaglia ancu cù .nav
s nidificati. Se un nidificatu .nav
hè .active
, i so genitori seranu ancu .active
. Scorri l'area accantu à a barra di navigazione è fighjate u cambiamentu di classa attiva.
Articulu 1
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Elementu 1-1
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Elementu 1-2
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Articulu 2
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Articulu 3
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Articulu 3-1
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
Elementu 3-2
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Tenite in mente chì u plugin JavaScript prova di sceglie l'elementu ghjustu trà tuttu ciò chì pò esse visibili. Multiple target scrollspy visibili à u stessu tempu pò causà certi prublemi.
<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>
Lista di gruppu
Scrollspy travaglia dinù cù .list-group
s. Scorri l'area accantu à u gruppu di lista è fighjate u cambiamentu di classa attiva.
Articulu 1
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 2
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 3
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 4
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
<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>
Ancore simplici
Scrollspy ùn hè micca limitatu à i cumpunenti di u navigatore è i gruppi di lista, perchè travaglià nantu à qualsiasi <a>
elementi di ancora in u documentu attuale. Scorri l'area è fighjate u .active
cambiamentu di classa.
Articulu 1
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 2
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 3
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Articulu 4
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
Puntu 5
Questu hè un cuntenutu di piazzamentu per a pagina scrollspy. Nota chì mentre scorri a pagina, u ligame di navigazione appropritatu hè evidenziatu. Hè ripetutu in tuttu l'esempiu di cumpunenti. Continuemu à aghjunghje un pocu di copie di esempiu quì per enfatizà u scrolling è l'evidenziazione.
<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>
Elementi micca visibili
L'elementi di destinazione chì ùn sò micca visibili seranu ignorati è i so elementi di navigazione currispondenti ùn riceveranu micca una .active
classe. L'istanze di Scrollspy inizializzate in un wrapper micca visibile ignoraranu tutti l'elementi di destinazione. Aduprate u refresh
metudu per verificà l'elementi observabili una volta chì u wrapper diventa visibile.
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()
})
})
Usu
Via attributi di dati
Per aghjunghje facilmente u cumpurtamentu scrollspy à a vostra navigazione in cima, aghjunghje data-bs-spy="scroll"
à l'elementu chì vulete spià (a più tipica questu seria u <body>
). Allora aghjunghje l' data-bs-target
attributu cù u id
nome di classa o di l'elementu parente di qualsiasi .nav
cumpunente 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>
Via JavaScript
const scrollSpy = new bootstrap.ScrollSpy(document.body, {
target: '#navbar-example'
})
Opzioni
Siccomu l'opzioni ponu esse passati via attributi di dati o JavaScript, pudete appiccicà un nome d'opzione à data-bs-
, cum'è in data-bs-animation="{value}"
. Assicuratevi di cambià u tipu di casu di u nome di l'opzione da " camelCase " à " kebab-case " quandu passanu l'opzioni via attributi di dati. Per esempiu, aduprà data-bs-custom-class="beautifier"
invece di data-bs-customClass="beautifier"
.
A partire da Bootstrap 5.2.0, tutti i cumpunenti supportanu un attributu di dati riservatu sperimentaledata-bs-config
chì pò accoglie una cunfigurazione di cumpunenti simplice cum'è una stringa JSON. Quandu un elementu hà data-bs-config='{"delay":0, "title":123}'
è data-bs-title="456"
attributi, u valore finali title
serà 456
è l'attributi di dati separati anu da annullà i valori dati nantu à data-bs-config
. Inoltre, l'attributi di dati esistenti sò capaci di allughjà valori JSON cum'è data-bs-delay='{"show":0,"hide":150}'
.
Nome | Tipu | Default | Descrizzione |
---|---|---|---|
rootMargin |
stringa | 0px 0px -25% |
Intersection Observer rootMargin unità validi, quandu calculà a pusizione di scorrimentu. |
smoothScroll |
booleanu | false |
Permette u scrolling fluidu quandu un utilizatore cliccate nantu à un ligame chì si riferisce à l'osservabili ScrollSpy. |
target |
stringa, elementu DOM | null |
Specifica l'elementu per applicà u plugin Scrollspy. |
threshold |
array | [0.1, 0.5, 1] |
IntersectionObserver threshold input validu, quandu calcula a pusizione di scorrimentu. |
Opzioni obsolete
Finu à v5.1.3 avemu usatu offset
& method
opzioni, chì sò oghji obsoleti è rimpiazzati da rootMargin
. Per mantene a cumpatibilità inversa, continueremu à analizà un datu offset
à rootMargin
, ma sta funzione serà eliminata in v6 .
I metudi
Metudu | Descrizzione |
---|---|
dispose |
Distrughje u scrollspy di un elementu. (Elimina i dati almacenati nantu à l'elementu DOM) |
getInstance |
Metudu staticu per uttene l'istanza scrollspy assuciata à un elementu DOM. |
getOrCreateInstance |
Metudu staticu per uttene l'istanza scrollspy assuciata à un elementu DOM, o per creà un novu in casu ùn hè micca inizializatu. |
refresh |
Quandu aghjunghje o sguassate elementi in u DOM, avete bisognu di chjamà u metudu di rinfrescante. |
Eccu un esempiu cù u metudu di rinfrescante:
const dataSpyList = document.querySelectorAll('[data-bs-spy="scroll"]')
dataSpyList.forEach(dataSpyEl => {
bootstrap.ScrollSpy.getInstance(dataSpyEl).refresh()
})
Avvenimenti
Avvenimentu | Descrizzione |
---|---|
activate.bs.scrollspy |
Questu avvenimentu spara nantu à l'elementu di scroll ogni volta chì un ancora hè attivatu da u scrollspy. |
const firstScrollSpyEl = document.querySelector('[data-bs-spy="scroll"]')
firstScrollSpyEl.addEventListener('activate.bs.scrollspy', () => {
// do something...
})