Scrollspy

Actualice automáticamente la navegación Bootstrap o enumere los componentes del grupo en función de la posición de desplazamiento para indicar qué enlace está actualmente activo en la ventana gráfica.

Cómo funciona

Scrollspy tiene algunos requisitos para funcionar correctamente:

Si está construyendo nuestro JavaScript desde la fuente, requiere util.js .
Debe usarse en un componente de navegación Bootstrap o en un grupo de listas .
Scrollspy requiere position: relative; el elemento que está espiando, generalmente el <body>.
Al espiar elementos que no sean <body> , asegúrese de tener un height conjunto y overflow-y: scroll; aplicarlo.
Los anclajes ( <a> ) son obligatorios y deben apuntar a un elemento con eso id.

Cuando se implemente con éxito, su grupo de navegación o lista se actualizará en consecuencia, moviendo la .active clase de un elemento al siguiente en función de sus objetivos asociados.

Desplácese por el área debajo de la barra de navegación y observe cómo cambia la clase activa. Los elementos del menú desplegable también se resaltarán.

@fat

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi antes de que se agotaran qui. Derechos de bicicletas de la granja a la mesa de Tumblr. Cárdigan anim keffiyeh carles. Fotomatón de velit seitan mcsweeney 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui probablemente no hayas oído hablar de ellos et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tatuado accusamus, cred ironía biodiesel keffiyeh artesano ullamco consequat.

@mdo

Veniam marfa bigote monopatín, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat cuatro loko nisi, ea helvetica nulla carles. Camión de comida de suéter cosby tatuado, vinilo quis non freegan de mcsweeney. Lo-fi wes anderson +1 sartorial. Carles quisiera gentrificar la ejercitación no estética. Brooklyn adipisicing cerveza artesanal vice keytar deserunt.

one

Occaecat commodo aliqua delectus. Fap cerveza artesanal deserunt monopatín ea. Lomo bike rights adipisicing banh mi, velit ea sunt siguiente nivel locavore café de origen único en magna veniam. Vinilo high life id, echo park consequat quis aliquip banh mi tridente. Vero VHS est adipisicing. Bolsa de mensajero Consectetur nisi DIY minim. Cred ex in, riñonera iphone sostenible delectus consectetur.

two

En incididunt echo park, el maestro proident de officia deserunt mcsweeney limpia thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum cerveza artesanal. Los viajeros de café de origen único irure four loko, cupidatat terry richardson master cleanse. Assumenda probablemente no has oído hablar de ellos, una riñonera de fiesta de arte, un anuncio temporal de cárdigan nulla tatuado. Proident wolf nesciunt sartorial keffiyeh eu banh mi sostenible. Elit wolf voluptate, lo-fi ea portland antes de que se agotaran cuatro loko. Locavore enim nostrud mlkshk brooklyn nesciunt.

three

Blog keytar twee, bolsa de mensajero culpa marfa cualquier camión de comida delectus. Sapiente synth id assumenda. Locavore sed helvetica cliché ironía, thundercats probablemente no hayas oído hablar de ellos consequat hoodie lo-fi fap aliquip sin gluten. Labore elit placeat antes de que se agotaran, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan cerveza artesanal seitán readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.


  <nav id="navbar-example2" class="navbar navbar-light bg-light">
    <a class="navbar-brand" href="#">Navbar</a>
    <ul class="nav nav-pills">
      <li class="nav-item">
        <a class="nav-link" href="#fat">@fat</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#mdo">@mdo</a>
      </li>
      <li class="nav-item dropdown">
        <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
        <div class="dropdown-menu">
          <a class="dropdown-item" href="#one">one</a>
          <a class="dropdown-item" href="#two">two</a>
          <div role="separator" class="dropdown-divider"></div>
          <a class="dropdown-item" href="#three">three</a>
        </div>
      </li>
    </ul>
  </nav>
  <div data-spy="scroll" data-target="#navbar-example2" data-offset="0">
    <h4 id="fat">@fat</h4>
    <p>...</p>
    <h4 id="mdo">@mdo</h4>
    <p>...</p>
    <h4 id="one">one</h4>
    <p>...</p>
    <h4 id="two">two</h4>
    <p>...</p>
    <h4 id="three">three</h4>
    <p>...</p>
  </div>

Ejemplo con navegación anidada

Scrollspy también funciona con .nav anidados. Si un anidado .nav es .active , sus padres también lo serán .active . Desplácese por el área junto a la barra de navegación y observe cómo cambia la clase activa.

Item 1

Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

Item 1-1

Amet tempor mollit aliquip pariatur excepteur commodo do ea cillum commodo Lorem et occaecat elit qui et. Aliquip labore ex ex esse voluptate occaecat Lorem ullamco deserunt. Aliqua cillum excepteur irure consequat id quis ea. Sit proident ullamco aute magna pariatur nostrud labore. Reprehenderit aliqua commodo eiusmod aliquip est do duis amet proident magna consectetur consequat eu commodo fugiat non quis. Enim aliquip exercitation ullamco adipisicing voluptate excepteur minim exercitation minim minim commodo adipisicing exercitation officia nisi adipisicing. Anim id duis qui consequat labore adipisicing sint dolor elit cillum anim et fugiat.

Item 1-2

Cillum nisi deserunt magna eiusmod qui eiusmod velit voluptate pariatur laborum sunt enim. Irure laboris mollit consequat incididunt sint et culpa culpa incididunt adipisicing magna magna occaecat. Nulla ipsum cillum eiusmod sint elit excepteur ea labore enim consectetur in labore anim. Proident ullamco ipsum esse elit ut Lorem eiusmod dolor et eiusmod. Anim occaecat nulla in non consequat eiusmod velit incididunt.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 3-1

Deserunt quis elit Lorem eiusmod amet enim enim amet minim Lorem proident nostrud. Ea id dolore anim exercitation aute fugiat labore voluptate cillum do laboris labore. Ex velit exercitation nisi enim labore reprehenderit labore nostrud ut ut. Esse officia sunt duis aliquip ullamco tempor eiusmod deserunt irure nostrud irure. Ullamco proident veniam laboris ea consectetur magna sunt ex exercitation aliquip minim enim culpa occaecat exercitation. Est tempor excepteur aliquip laborum consequat do deserunt laborum esse eiusmod irure proident ipsum esse qui.

Item 3-2

Labore sit culpa commodo elit adipisicing sit aliquip elit proident voluptate minim mollit nostrud aute reprehenderit do. Mollit excepteur eu Lorem ipsum anim commodo sint labore Lorem in exercitation velit incididunt. Occaecat consectetur nisi in occaecat proident minim enim sunt reprehenderit exercitation cupidatat et do officia. Aliquip consequat ad labore labore mollit ut amet. Sit pariatur tempor proident in veniam culpa aliqua excepteur elit magna fugiat eiusmod amet officia.


  <nav id="navbar-example3" class="navbar navbar-light bg-light">
    <a class="navbar-brand" href="#">Navbar</a>
    <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 ml-3 my-1" href="#item-1-1">Item 1-1</a>
        <a class="nav-link ml-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 ml-3 my-1" href="#item-3-1">Item 3-1</a>
        <a class="nav-link ml-3 my-1" href="#item-3-2">Item 3-2</a>
      </nav>
    </nav>
  </nav>
  
  <div data-spy="scroll" data-target="#navbar-example3" data-offset="0">
    <h4 id="item-1">Item 1</h4>
    <p>...</p>
    <h5 id="item-1-1">Item 1-1</h5>
    <p>...</p>
    <h5 id="item-1-2">Item 1-2</h5>
    <p>...</p>
    <h4 id="item-2">Item 2</h4>
    <p>...</p>
    <h4 id="item-3">Item 3</h4>
    <p>...</p>
    <h5 id="item-3-1">Item 3-1</h5>
    <p>...</p>
    <h5 id="item-3-2">Item 3-2</h5>
    <p>...</p>
  </div>

Ejemplo con list-group

Scrollspy también funciona con .list-group Desplácese por el área junto al grupo de la lista y observe cómo cambia la clase activa.

Item 1 Item 2 Item 3 Item 4

Item 1

Ex consequat commodo adipisicing ejercitation aute excepteur Occaecat ullamco duis aliqua id magna ullamco eu. Realice aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim ejercicio cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident Occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 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 data-spy="scroll" data-target="#list-example" data-offset="0" class="scrollspy-example">
    <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>

Uso

A través de atributos de datos

Para agregar fácilmente el comportamiento scrollspy a la navegación de la barra superior, agréguelo data-spy="scroll" al elemento que desea espiar (por lo general, este sería el <body> ). Luego agregue el data-target atributo con el ID o la clase del elemento principal de cualquier .nav componente de Bootstrap .


  body {
    position: relative;
  }


  <body data-spy="scroll" data-target="#navbar-example">
    ...
    <div id="navbar-example">
      <ul class="nav nav-tabs" role="tablist">
        ...
      </ul>
    </div>
    ...
  </body>

Vía JavaScript

Después de agregar position: relative; su CSS, llame a scrollspy a través de JavaScript:


  $('body').scrollspy({ target: '#navbar-example' })

Se requieren objetivos de identificación que se puedan resolver

Los enlaces de la barra de navegación deben tener destinos de identificación que se puedan resolver. Por ejemplo, <a href="#home">home</a> debe corresponder a algo en el DOM como <div id="home"></div>.

`:visible` Elementos no objetivo ignorados

Los elementos de destino que no están de :visible acuerdo con jQuery se ignorarán y sus elementos de navegación correspondientes nunca se resaltarán.

Métodos

`.scrollspy('refresh')`

Cuando use scrollspy junto con la adición o eliminación de elementos del DOM, deberá llamar al método de actualización de esta manera:


  $('[data-spy="scroll"]').each(function () {
    var $spy = $(this).scrollspy('refresh')
  })

`.scrollspy('dispose')`

Destruye el scrollspy de un elemento.

Opciones

Las opciones se pueden pasar a través de atributos de datos o JavaScript. Para los atributos de datos, agregue el nombre de la opción a data- , como en data-offset="".

Nombre	Tipo	Defecto	Descripción
compensar	número	10	Píxeles para compensar desde la parte superior al calcular la posición del desplazamiento.
método	cuerda	auto	Encuentra en qué sección se encuentra el elemento espiado. `auto` Elegirá el mejor método para obtener las coordenadas de desplazamiento. `offset` usará el método de compensación jQuery para obtener coordenadas de desplazamiento. `position` usará el método de posición jQuery para obtener coordenadas de desplazamiento.
objetivo	cadena \| objeto jQuery \| Elemento DOM		Especifica el elemento para aplicar el complemento Scrollspy.

Eventos

Tipo de evento	Descripción
active.bs.scrollspy	Este evento se dispara en el elemento de desplazamiento cada vez que scrollspy activa un nuevo elemento.


  $('[data-spy="scroll"]').on('activate.bs.scrollspy', function () {
    // do something...
  })

Scrollspy

Cómo funciona

Ejemplo en la barra de navegación

@fat

@mdo

one

two

three

Ejemplo con navegación anidada

Item 1

Item 1-1

Item 1-2

Item 2

Item 3

Item 3-1

Item 3-2

Ejemplo con list-group

Item 1

Item 2

Item 3

Item 4

Uso

A través de atributos de datos

Vía JavaScript

Se requieren objetivos de identificación que se puedan resolver

:visible Elementos no objetivo ignorados

Métodos

.scrollspy('refresh')

.scrollspy('dispose')

Opciones

Eventos

`:visible` Elementos no objetivo ignorados

`.scrollspy('refresh')`

`.scrollspy('dispose')`