In diesem Codelab erfahren Sie, wie Sie eine responsive Layoutkomponente für die seitliche Navigation im Web erstellen. Wir erstellen die Komponente Schritt für Schritt, beginnend mit HTML, dann CSS und schließlich JavaScript.
In meinem Blogpost Building a Sidenav component (Sidenav-Komponente erstellen) erfahren Sie, welche CSS-Webplattformfunktionen für die Erstellung dieser Komponente ausgewählt wurden.
Einrichtung
- Klicken Sie auf Remix erstellen, um zu bearbeiten, um das Projekt bearbeitbar zu machen.
- Öffnen Sie
app/index.html.
HTML
Zuerst benötigen Sie die Grundlagen der HTML-Einrichtung, damit Sie Inhalte und einige Boxen haben, mit denen Sie arbeiten können.
Fügen Sie den folgenden HTML-Code in das <body>-Tag ein.
<aside></aside>
<main></main>
Das <aside>-Element enthält das Navigationsmenü als ergänzendes Element zu <main>, das den primären Seiteninhalt enthält.
Als Nächstes füllen wir diese semantischen Elemente mit dem restlichen Seiteninhalt.
Fügen Sie im <aside>-Element ein Navigationselement, einige Navigationslinks und einen Link zum Schließen hinzu.
<aside>
<nav>
<h4>My</h4>
<a href="#">Dashboard</a>
<a href="#">Profile</a>
<a href="#">Preferences</a>
<a href="#">Archive</a>
<h4>Settings</h4>
<a href="#">Accessibility</a>
<a href="#">Theme</a>
<a href="#">Admin</a>
</nav>
<a href="#"></a>
</aside>
Links passen gut in <nav>-Elemente und <nav>-Elemente passen gut in <aside>-Seitenleisten.
Wir können aber noch mehr tun, um uns zu verbessern.
Fügen Sie im Hauptelement einen Header und einen Artikel hinzu, um den Layoutinhalt semantisch zu strukturieren.
<main>
<header>
<a href="#sidenav-open" class="hamburger">
<svg viewBox="0 0 50 40">
<line x1="0" x2="100%" y1="10%" y2="10%" />
<line x1="0" x2="100%" y1="50%" y2="50%" />
<line x1="0" x2="100%" y1="90%" y2="90%" />
</svg>
</a>
<h1>Site Title</h1>
</header>
<article>
{put some placeholder content here}
</article>
</main>
In der Kopfzeile befindet sich der Link zum Öffnen des Menüs. Das aside-Element enthält die Schaltfläche zum Schließen. Wir werden Elemente bald basierend auf der Größe des Darstellungsbereichs ein- und ausblenden.
In das <article>-Element haben wir einen Platzhaltersatz eingefügt. Ersetzen Sie `` durch Ihre eigenen Inhalte oder fügen Sie den unten angegebenen Lorem-Ipsum-Text ein:
<h2>Totam Header</h2>
<p>Lorem ipsum dolor, sit amet consectetur adipisicing elit. Cum consectetur, necessitatibus velit officia ut impedit veritatis temporibus soluta? Totam odit cupiditate facilis nisi sunt hic necessitatibus voluptatem nihil doloribus! Enim.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<h3>Subhead Totam Odit</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<h3>Subhead</h3>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
<p>Lorem ipsum dolor sit, amet consectetur adipisicing elit. Fugit rerum, amet odio explicabo voluptas eos cum libero, ex esse quasi optio incidunt soluta eligendi labore error corrupti! Dolore, cupiditate porro.</p>
Dieser Inhalt und seine Länge führen dazu, dass die Seite scrollbar ist, wenn sie die Höhe des Darstellungsbereichs überschreitet.
Bisher haben Sie ein aside-Element mit einer Navigationsleiste, Links und einer Möglichkeit zum Schließen der seitlichen Navigationsleiste hinzugefügt. Sie haben außerdem einen Header, eine Möglichkeit zum Öffnen der seitlichen Navigation und einen Artikel zum Hauptelement hinzugefügt. Das ist sauber, semantisch und schon ziemlich zeitlos, aber wir können es für alle noch sauberer und klarer machen. Der Link zum Öffnen in der Seitenleiste könnte deutlicher gekennzeichnet sein.
Fügen Sie dem öffnenden Link-Element im Header die Attribute title und aria-label hinzu:
<a href="#sidenav-open" class="hamburger">
<a href="#sidenav-open" title="Open Menu" aria-label="Open Menu" class="hamburger">
Das Symbol zum Öffnen von SVG-Dateien könnte ebenfalls deutlicher gekennzeichnet sein. Fügen Sie der SVG-Datei im geöffneten Link-Element die folgenden Attribute hinzu:
<svg viewBox="0 0 50 40">
<svg viewBox="0 0 50 40" role="presentation" focusable="false" aria-label="trigram for heaven symbol">
Der Link zum Schließen in der Seitennavigation könnte deutlicher gekennzeichnet sein.
Fügen Sie dem Link-Element zum Schließen der Sidenav die Attribute title und aria-label hinzu:
<a href="#"></a>
<a href="#" title="Close Menu" aria-label="Close Menu"></a>
CSS
Jetzt werden die Elemente angeordnet. Der Hauptinhalt und die Sidenav sind direkt untergeordnete Elemente des <body>-Tags. Das ist also ein guter Ausgangspunkt.
Fügen Sie das folgende CSS in css/sidenav.css ein, damit das <body>-Element die untergeordneten Elemente anordnet.
body {
display: grid;
grid: [stack] 1fr / min-content [stack] 1fr;
@media (max-width: 540px) {
& > :matches(aside, main) {
grid-area: stack;
}
}
}
Dieses Layout bedeutet im Wesentlichen: Erstellen Sie eine benannte Zeile stack mit allen Elementen und zwei Spalten in dieser Zeile, von denen die zweite ebenfalls den Namen stack hat. Die erste Spalte sollte nach ihrem minimalen Inhaltsbedarf dimensioniert werden und die zweite Spalte kann den Rest einnehmen.
Wenn der Darstellungsbereich auf 540px oder weniger beschränkt ist, werden die Elemente für die seitliche Navigation und den Hauptinhalt in dieselbe Zeile und Spalte eingefügt, sodass sie in einem 1×1-Raster übereinander liegen.
Mit dieser responsiven Stapelfunktion als Grundlage können wir jetzt den Status der URL-Leiste nutzen, um die Sichtbarkeit und den Übergangsstil der seitlichen Navigation umzuschalten.
Aktualisieren Sie das Element <aside> in app/index.html:
<aside>
<aside id="sidenav-open">
So kann CSS ein Element und den URL-Hash miteinander abgleichen. Das ist wichtig für die Nutzung von :target.
Jetzt kann die ID des Elements mit dem URL-Hash übereinstimmen, den wir mit <a>-Tags festlegen.
Fügen Sie außerdem IDs für wichtige Elemente hinzu, die die Sidenav steuern, um das JavaScript-Targeting zu vereinfachen. Fügen Sie zuerst dem Link zum Öffnen der seitlichen Navigation eine ID hinzu:
<a href="#sidenav-open" class="hamburger" title="Open Menu" aria-label="Open Menu">
<a href="#sidenav-open" id="sidenav-button" class="hamburger" title="Open Menu" aria-label="Open Menu">
Fügen Sie als Nächstes dem Link zum Schließen der Sidenav eine ID hinzu:
<a href="#" title="Close Menu" aria-label="Close Menu"></a>
<a href="#" id="sidenav-close" title="Close Menu" aria-label="Close Menu"></a>
Damit ist das responsive Stapellayout für das Makro <body> fertig und wir haben es mit der URL-Leiste verknüpft.
Weiter so!
Das <aside> hat auch ein übersichtliches Layout. Es hat zwei untergeordnete Elemente: ein <nav>-Element, das die papierähnliche Komponente ist, die herausgezogen wird, und ein schließendes <a>-Link-Element, das die URL auf # setzt.
Der Link ist rechts neben der Navigationsleiste unsichtbar. Er ist dazu da, dass Nutzer die visuelle Komponente „wegklicken“ können, um sie zu schließen.
Fügen Sie css/sidenav.css das folgende CSS hinzu:
#sidenav-open {
display: grid;
grid-template-columns: [nav] 2fr [escape] 1fr;
}
Ich fand das Verhältnis und die Namen hier sehr gut, da das Raster hier glänzen und einem Designer viel Kontrolle geben kann.
Als Nächstes muss ich den Hauptinhalt bedingt überlagern und meine Position beim Scrollen im Dokument beibehalten. Das ist eine gute Aufgabe für position: sticky und einige overscroll-behavior.
Fügen Sie die folgenden Stile für die Sidenav hinzu:
#sidenav-open {
display: grid;
grid-template-columns: [nav] 2fr [escape] 1fr;
@media (max-width: 540px) {
position: sticky;
top: 0;
max-height: 100vh;
overflow: hidden auto;
overscroll-behavior: contain;
visibility: hidden; /* not keyboard accessible when closed */
}
}
Diese Stile sorgen dafür, dass die Sidenav die Höhe des Darstellungsbereichs hat, vertikal scrollt und den Scrollvorgang enthält. Ganz wichtig: Das Element wird ausgeblendet. Wenn der Darstellungsbereich 540px oder kleiner ist, wird die seitliche Navigation standardmäßig ausgeblendet. Es sei denn…
Fügen Sie dem #sidenav-open-Element einen :target-Pseudoselektor hinzu:
#sidenav-open {
@media (max-width: 540px) {
&:target {
visibility: visible;
}
}
}
Wenn die ID dieses Elements und die URL-Leiste identisch sind, legen Sie visibility auf visible fest. Öffnen Sie das Seitenmenü, nachdem Sie auf der Seite gescrollt haben, oder scrollen Sie auf der Seite, während die Seitennavigation geöffnet ist. Was ist Ihre Meinung dazu?
Fügen Sie am Ende von app/sidenav.css das folgende CSS hinzu:
#sidenav-button,
#sidenav-close {
-webkit-tap-highlight-color: transparent;
-webkit-touch-callout: none;
user-select: none;
touch-action: manipulation;
@media (min-width: 540px) {
display: none;
}
}
Diese Stile gelten für die Schaltflächen zum Öffnen und Schließen, legen ihre Tipp- und Berührungsstile fest und blenden sie aus, wenn die Darstellungsbereiche 540px oder größer sind.
Für etwas mehr Flair fügen wir CSS-Transformationen mit barrierefreiem Zugriff hinzu.
Fügen Sie css/sidenav.css das folgende CSS hinzu:
#sidenav-open {
--easeOutExpo: cubic-bezier(0.16, 1, 0.3, 1);
--duration: .6s;
...
@media (max-width: 540px) {
...
transform: translateX(-110vw);
will-change: transform;
transition:
transform var(--duration) var(--easeOutExpo),
visibility 0s linear var(--duration);
&:target {
visibility: visible;
transform: translateX(0);
transition: transform var(--duration) var(--easeOutExpo);
}
}
@media (prefers-reduced-motion: reduce) {
--duration: 1ms;
}
}
JavaScript hinzufügen
Mit der Taste Escape sollte das Menü geschlossen werden. Fügen Sie diesen JS-Code zu js/index.js hinzu:
const sidenav = document.querySelector('#sidenav-open');
sidenav.addEventListener('keyup', e => {
if (e.code === 'Escape') {
document.location.hash = '';
}
});
Dadurch wird auf ein Schlüsselereignis im Element „sidenav“ gewartet.
Wenn der Wert Escape ist, wird der URL-Hash auf leer gesetzt, sodass die seitliche Navigation ausgeblendet wird.
Der nächste Teil von UX JS ist die Fokusverwaltung. Ich möchte das Öffnen und Schließen einfach gestalten. Deshalb warte ich, bis die Sidenav eine Art Übergang abgeschlossen hat, und vergleiche sie dann mit dem URL-Hash, um festzustellen, ob sie ein- oder ausgeblendet ist. Dann verwende ich JavaScript, um den Fokus auf die Schaltfläche zu setzen, die die gerade gedrückte ergänzt.
Fügen Sie js/index.js den folgenden JavaScript-Code hinzu:
const closenav = document.querySelector('#sidenav-close');
const opennav = document.querySelector('#sidenav-button');
sidenav.addEventListener('transitionend', e => {
if (e.propertyName !== 'transform') {
return;
}
const isOpen = document.location.hash === '#sidenav-open';
isOpen
? closenav.focus()
: opennav.focus();
});
Jetzt ausprobieren
- Wenn Sie sich eine Vorschau der Website ansehen möchten, klicken Sie auf View App (App ansehen) und dann auf Fullscreen (Vollbild)
.
Fazit
Das war alles, was ich für die Komponente brauchte. Sie können sie nach Belieben erweitern, mit JavaScript-Status statt der URL steuern und ganz allgemein an Ihre Anforderungen anpassen. Es gibt immer etwas hinzuzufügen oder weitere Anwendungsfälle abzudecken.
Öffnen Sie css/brandnav.css, um sich die nicht layoutbezogenen Stile anzusehen, die ich auf diese Komponente angewendet habe. Ich hielt es nicht für wichtig für die Funktionen, auf die ich mich konzentrierte, und hoffte, dass die Trennung von Stilen und Layout das Kopieren und Einfügen fördern würde. Vielleicht können Sie dort noch mehr lernen.
Wie erstellt man responsive seitliche Navigationskomponenten, die sich ausklappen lassen? Haben Sie manchmal mehr als einen, also einen auf jeder Seite? Ich würde deine Lösung gerne in einem YouTube-Video vorstellen. Schreib mir auf X oder kommentiere auf YouTube mit deinem Code. Das hilft allen weiter!