dynamic-sticky-sidebardynamic-sticky-sidebar
Leitfaden
  • Vanilla JS
  • React
  • Vue
API
Demo
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
Leitfaden
  • Vanilla JS
  • React
  • Vue
API
Demo
npm
  • English
  • فارسی
  • العربية
  • Deutsch
  • Français
  • Italiano
GitHub
  • Leitfaden

    • Einführung
    • Erste Schritte
    • Layout-Anforderungen
    • Dynamische Header
    • So funktioniert es
    • Fehlerbehebung
  • Frameworks

    • Vanilla JS
    • React
    • Vue
  • Referenz

    • API-Referenz
    • Live-Demo

Erste Schritte

Installation

npm
npm i dynamic-sticky-sidebar
pnpm
pnpm add dynamic-sticky-sidebar
yarn
yarn add dynamic-sticky-sidebar
CDN
<script src="https://unpkg.com/dynamic-sticky-sidebar"></script>
<!-- exposes window.StickySidebar.stickySidebar -->

1. Seite aufbauen

Setze die Sidebar neben den Inhalt in ein Grid (oder ein Flex-Layout in Zeilenrichtung) und verhindere, dass sie sich auf die volle Zeilenhöhe streckt:

<header class="site-header">…</header>

<div class="layout">
    <aside id="sidebar">…</aside>
    <main>…</main>
</div>
.site-header {
    position: sticky;
    top: 0;
    z-index: 10;
}

.layout {
    display: grid;
    grid-template-columns: 280px 1fr;
    gap: 32px;
    align-items: start; /* important: the sidebar keeps its own height */
}

Warum Grid?

Mit einem Grid- oder Zeilen-Flex-Container als Elternelement kann die Bibliothek in beide Richtungen natives Sticky-Verhalten nutzen. Block-Layouts funktionieren auch, beim Hochscrollen kommt dann aber ein JS-Fallback zum Einsatz. Siehe Layout-Anforderungen.

2. Sidebar anbinden

Vanilla
import { stickySidebar } from 'dynamic-sticky-sidebar';

const sidebar = stickySidebar('#sidebar', {
    header: '.site-header',
    gap: 16,
    media: '(min-width: 768px)',
});

// later, e.g. when the page unmounts
sidebar.destroy();
React
import { StickySidebar } from 'dynamic-sticky-sidebar/react';

export function Layout({ children }) {
    return (
        <div className="layout">
            <StickySidebar header=".site-header" gap={16} media="(min-width: 768px)">
                …
            </StickySidebar>
            <main>{children}</main>
        </div>
    );
}
Vue
<script setup>
import { vStickySidebar } from 'dynamic-sticky-sidebar/vue';

const sticky = { header: '.site-header', gap: 16, media: '(min-width: 768px)' };
</script>

<template>
    <div class="layout">
        <aside v-sticky-sidebar="sticky">…</aside>
        <main><slot /></main>
    </div>
</template>

Das war’s. Scrollst du nach unten, folgt die Sidebar dem Inhalt bis zu ihrem Ende und bleibt dann stehen. Scrollst du nach oben, kommt sie zurück und bleibt unter dem Header stehen – egal, wo der Header gerade ist.

3. Ausprobieren

Scrolle in der Box unten. Die Sub-Navigation rutscht beim Runterscrollen weg und kommt beim Hochscrollen zurück, und die Sidebar folgt ihr.

In neuem Tab öffnen
Shopin dieser Box scrollen ↓
CategoriesBrandsDeals
Filter 1
Filter 2
Filter 3
Filter 4
Filter 5
Filter 6
Filter 7
Filter 8
Filter 9
Filter 10
Filter 11
Filter 12
Filter 13
Filter 14
Filter 15
Filter 16
Filter 17
Filter 18 (last)
Card 1
Card 2
Card 3
Card 4
Card 5
Card 6
Card 7
Card 8
Card 9
Card 10
Card 11
Card 12
Card 13
Card 14
Card 15
Card 16
Card 17
Card 18
Card 19
Card 20
Card 21
Card 22
Card 23
Card 24
footer

Wie geht es weiter?

  • Layout-Anforderungen: Grid, Flex oder Block und häufige Stolperfallen
  • Dynamische Header: mehrere Header, per JS animierte Header und zustandsabhängige Offsets
  • API-Referenz: alle Optionen und Instanzmethoden
Diese Seite auf GitHub bearbeiten
Zurück
Einführung
Weiter
Layout-Anforderungen