Bootstrap 5 Tutorial

Bootstrap 5 Scrollspy

Last modified on: October 27, 2024

<div class="flex-shrink-0 flex flex-col relative items-end">
<div>
<div class="pt-0">
<div class="gizmo-bot-avatar flex h-8 w-8 items-center justify-center overflow-hidden rounded-full">&nbsp;</div>
</div>
</div>
</div>
<div class="group/conversation-turn relative flex w-full min-w-0 flex-col agent-turn">
<div class="flex-col gap-1 md:gap-3">
<div class="flex max-w-full flex-col flex-grow">
<div class="min-h-8 text-message flex w-full flex-col items-end gap-2 whitespace-normal break-words [.text-message+&amp;]:mt-5" dir="auto" data-message-author-role="assistant" data-message-id="c8efa51b-bbe8-4dc5-9396-afd183489c9f" data-message-model-slug="gpt-4o">
<div class="flex w-full flex-col gap-1 empty:hidden first:pt-[3px]">
<div class="markdown prose w-full break-words dark:prose-invert light">
<h3>Bootstrap 5: Scrollspy</h3>
<p>Scrollspy in Bootstrap 5 is a JavaScript feature that automatically updates navigation elements based on the user's scroll position. It's ideal for single-page websites and long pages where sections change as you scroll, helping users easily navigate to different sections by highlighting the current active link.</p>
<hr />
<h3>Key Features of Bootstrap 5 Scrollspy</h3>
<ol>
<li><strong>Automatic Link Highlighting</strong>: Dynamically highlights active navigation links as the user scrolls through sections.</li>
<li><strong>Flexible Positioning</strong>: Works with vertically or horizontally aligned navigation.</li>
<li><strong>Smooth User Experience</strong>: Provides clear feedback on the user&rsquo;s current location on the page.</li>
<li><strong>JavaScript API</strong>: Allows programmatic control over the scroll behavior and customization.</li>
</ol>
<hr />
<h3>Example: Implementing Scrollspy in Bootstrap 5</h3>
<p>Here&rsquo;s a basic example showing how to create a Scrollspy-enabled navigation menu with Bootstrap 5:</p>
<div class="contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative bg-token-sidebar-surface-primary dark:bg-gray-950">
<div class="flex items-center text-token-text-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9 bg-token-sidebar-surface-primary dark:bg-token-main-surface-secondary">html</div>
<div class="sticky top-9 md:top-[5.75rem]">
<div class="absolute bottom-0 right-2 flex h-9 items-center">
<div class="flex items-center rounded bg-token-sidebar-surface-primary px-2 font-sans text-xs text-token-text-secondary dark:bg-token-main-surface-secondary">
<pre class="language-markup"><code>&lt;!DOCTYPE html&gt;
&lt;html lang="en"&gt;
&lt;head&gt;
    &lt;meta charset="UTF-8"&gt;
    &lt;meta name="viewport" content="width=device-width, initial-scale=1.0"&gt;
    &lt;title&gt;Bootstrap 5 Scrollspy Example&lt;/title&gt;
    &lt;link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha3/dist/css/bootstrap.min.css" rel="stylesheet"&gt;
    &lt;style&gt;
        body {
            position: relative;
        }
        .section {
            height: 500px;
            padding-top: 60px;
        }
    &lt;/style&gt;
&lt;/head&gt;
&lt;body data-bs-spy="scroll" data-bs-target="#navbar-example" data-bs-offset="70" tabindex="0"&gt;

&lt;!-- Navbar for Scrollspy --&gt;
    &lt;nav id="navbar-example" class="navbar navbar-light bg-light fixed-top"&gt;
        &lt;a class="navbar-brand" href="#"&gt;Scrollspy Demo&lt;/a&gt;
        &lt;ul class="nav nav-pills"&gt;
            &lt;li class="nav-item"&gt;
                &lt;a class="nav-link" href="#section1"&gt;Section 1&lt;/a&gt;
            &lt;/li&gt;
            &lt;li class="nav-item"&gt;
                &lt;a class="nav-link" href="#section2"&gt;Section 2&lt;/a&gt;
            &lt;/li&gt;
            &lt;li class="nav-item"&gt;
                &lt;a class="nav-link" href="#section3"&gt;Section 3&lt;/a&gt;
            &lt;/li&gt;
        &lt;/ul&gt;
    &lt;/nav&gt;

&lt;!-- Scrollable Content Sections --&gt;
    &lt;div id="section1" class="section bg-primary text-white"&gt;
        &lt;h1&gt;Section 1&lt;/h1&gt;
        &lt;p&gt;Content for the first section...&lt;/p&gt;
    &lt;/div&gt;
    &lt;div id="section2" class="section bg-secondary text-white"&gt;
        &lt;h1&gt;Section 2&lt;/h1&gt;
        &lt;p&gt;Content for the second section...&lt;/p&gt;
    &lt;/div&gt;
    &lt;div id="section3" class="section bg-success text-white"&gt;
        &lt;h1&gt;Section 3&lt;/h1&gt;
        &lt;p&gt;Content for the third section...&lt;/p&gt;
    &lt;/div&gt;

&lt;script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha3/dist/js/bootstrap.bundle.min.js"&gt;&lt;/script&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
</div>
</div>
</div>
</div>
<h3>Explanation of the Code</h3>
<ul>
<li><strong>Body Attributes</strong>: <code>data-bs-spy="scroll"</code>, <code>data-bs-target="#navbar-example"</code>, and <code>data-bs-offset="70"</code> set up the Scrollspy. The <code>data-bs-target</code> attribute links to the navigation bar, and <code>data-bs-offset</code> ensures the highlighted section aligns correctly with the navbar.</li>
<li><strong>Navigation Links</strong>: The navigation bar includes links pointing to each section, which Bootstrap highlights automatically as the user scrolls.</li>
<li><strong>Scrollable Sections</strong>: Each section has an <code>id</code> matching the link <code>href</code> values. These sections have padding to provide space for the fixed navbar at the top.</li>
</ul>
<hr />
<h3>&nbsp;</h3>
</div>
</div>
</div>
</div>
</div>
</div>

Web Technology View More