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

    • Introduction
    • Premiers pas
    • Contraintes de mise en page
    • En-têtes dynamiques
    • Comment ça marche
    • Dépannage
  • Frameworks

    • Vanilla JS
    • React
    • Vue
  • Référence

    • Référence de l'API
    • Démo en direct

Premiers pas

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. Mettre en page

Placez la barre latérale dans une grille (ou un flex en ligne) à côté du contenu, et empêchez-la de s'étirer sur toute la hauteur de la rangée :

<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 */
}

Pourquoi une grille ?

Un parent en grille ou en flex en ligne permet à la bibliothèque d'utiliser le comportement sticky natif dans les deux sens. Les mises en page en bloc fonctionnent aussi, mais la remontée passe alors par une solution de repli en JS. Voir Contraintes de mise en page.

2. Attacher la barre latérale

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>

C'est tout. Faites défiler vers le bas : la barre latérale accompagne le contenu jusqu'à sa fin, puis se fixe. Remontez : elle revient et se fixe sous l'en-tête, où qu'il se trouve à ce moment-là.

3. Essayer

Faites défiler l'intérieur du cadre ci-dessous. La sous-navigation disparaît quand vous descendez et revient quand vous remontez, et la barre latérale la suit.

Ouvrir dans un nouvel onglet
Shopfaites défiler dans ce cadre ↓
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

Pour aller plus loin

  • Contraintes de mise en page : grid, flex ou bloc, et les pièges courants
  • En-têtes dynamiques : plusieurs en-têtes, en-têtes animés en JS et décalages pilotés par l'état
  • Référence de l'API : toutes les options et méthodes d'instance
Modifier cette page sur GitHub
Précédent
Introduction
Suivant
Contraintes de mise en page