Codelab: creazione di un componente di Barra di navigazione laterale

Questo codelab ti insegna come creare un componente di layout di navigazione laterale scorrevole adattabile sul web. Creeremo il componente man mano, iniziando con HTML, poi CSS e infine JavaScript.

Leggi il mio blog post Creazione di un componente Sidenav per scoprire le funzionalità della piattaforma web CSS scelte per la creazione di questo componente.

Configurazione

  1. Fai clic su Remixa per modificare per rendere il progetto modificabile.
  2. Apri app/index.html.

HTML

Innanzitutto, acquisisci le nozioni di base della configurazione HTML in modo da avere contenuti e alcune caselle con cui lavorare.

Inserisci il seguente codice HTML nel tag <body>.

<aside></aside>
<main></main>

L'elemento <aside> contiene il menu di navigazione come elemento complementare a <main>, che contiene i contenuti principali della pagina.

Successivamente, inseriremo in questi elementi semantici il resto dei contenuti della pagina.

Aggiungi un elemento di navigazione, alcuni link di navigazione e un link di chiusura all'interno dell'elemento <aside>.

<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>

I link sono perfetti all'interno degli elementi <nav>, che <nav> a loro volta sono perfetti nelle barre laterali <aside>. Tuttavia, possiamo fare di più per migliorare.

Nell'elemento dei contenuti principali, aggiungi un'intestazione e un articolo per contenere semanticamente i contenuti del layout.

<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>

L'intestazione contiene il link per aprire il menu. La sezione laterale contiene il pulsante di chiusura. A breve mostreremo e nasconderemo gli elementi in base alle dimensioni dell'area visibile.

Nell'elemento <article>, abbiamo incollato una frase segnaposto. Sostituisci "" con i tuoi contenuti o incolla il testo di esempio fornito di seguito:

<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>

Questi contenuti e la loro lunghezza renderanno la pagina scorrevole quando supererà l'altezza dell'area visibile.

Finora hai aggiunto un elemento aside, con un nav, dei link e un modo per chiudere la navigazione laterale. Hai anche aggiunto un'intestazione, un modo per aprire la barra di navigazione laterale e un articolo all'elemento principale. Questo è un codice pulito, semantico e già abbastanza senza tempo, ma possiamo renderlo più pulito e chiaro per tutti. Il link di apertura nella barra di navigazione laterale potrebbe essere contrassegnato in modo più chiaro.

Aggiungi gli attributi title e aria-label all'elemento link di apertura dell'intestazione:

<a href="#sidenav-open" class="hamburger">
<a href="#sidenav-open" title="Open Menu" aria-label="Open Menu" class="hamburger">

Anche l'icona SVG aperta potrebbe essere contrassegnata in modo più chiaro. Aggiungi i seguenti attributi all'SVG all'interno dell'elemento link aperto:

<svg viewBox="0 0 50 40">
<svg viewBox="0 0 50 40" role="presentation" focusable="false" aria-label="trigram for heaven symbol">

Il link di chiusura nella navigazione laterale potrebbe essere contrassegnato in modo più chiaro. Aggiungi gli attributi title e aria-label all'elemento link di chiusura della navigazione laterale:

<a href="#"></a>
<a href="#" title="Close Menu" aria-label="Close Menu"></a>

CSS

È il momento di disporre gli elementi. I contenuti principali e la barra di navigazione laterale sono elementi secondari diretti del tag <body>, quindi è un buon punto di partenza.

Aggiungi il seguente CSS in css/sidenav.css in modo che l'elemento <body> disponga gli elementi secondari.

body {
  display: grid;
  grid: [stack] 1fr / min-content [stack] 1fr;

  @media (max-width: 540px) {
    & > :matches(aside, main) {
      grid-area: stack;
    }
  }
}

Questo layout indica essenzialmente: crea una riga denominata stack con tutti gli elementi al suo interno e 2 colonne in quella riga, la seconda delle quali è denominata anche stack. La prima colonna deve essere dimensionata in base alle esigenze minime dei contenuti, mentre la seconda colonna può occupare il resto dello spazio. Poi, se la larghezza dell'area visibile è pari o inferiore a 540px, inserisci gli elementi della barra di navigazione laterale e dei contenuti principali nella stessa riga e colonna, in modo che si trovino uno sopra l'altro in una griglia 1x1.

Con questa funzionalità di impilamento adattabile come base, ora possiamo sfruttare lo stato della barra degli URL per attivare/disattivare la visibilità e lo stile di transizione della navigazione laterale.

Aggiorna l'elemento <aside> in app/index.html:

<aside>
<aside id="sidenav-open">

In questo modo, CSS può abbinare un elemento e l'hash dell'URL. Questo è importante per l'utilizzo di :target. Ora l'ID dell'elemento può corrispondere all'hash dell'URL che imposteremo con i tag <a>.

Inoltre, per semplificare il targeting JavaScript, aggiungi gli ID per gli elementi chiave che controllano la navigazione laterale. Innanzitutto, aggiungi un ID al link di apertura della barra di navigazione laterale:

<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">

Poi, aggiungi un ID al link di chiusura della barra di navigazione laterale:

<a href="#" title="Close Menu" aria-label="Close Menu"></a>
<a href="#" id="sidenav-close" title="Close Menu" aria-label="Close Menu"></a>

Questo conclude il layout di impilamento adattabile della macro <body> e ci collega alla barra degli URL. Andiamo avanti.

Anche il <aside> ha un layout ordinato. Ha due elementi secondari: un elemento <nav>, che è il componente simile a un foglio di carta che si apre, e un elemento link di chiusura <a> che imposta l'URL su #. Il link è invisibile a destra del riquadro di navigazione a scomparsa; serve per consentire agli utenti di "fare clic" sul componente visivo per chiuderlo.

Aggiungi il seguente CSS a css/sidenav.css:

#sidenav-open {
  display: grid;
  grid-template-columns: [nav] 2fr [escape] 1fr;
}

Penso che le proporzioni e i nomi siano un tocco davvero carino, dove la griglia potrebbe brillare e dare a un designer un grande controllo.

Successivamente, devo sovrapporre in modo condizionale i contenuti principali e mantenere la mia posizione durante lo scorrimento del documento. Questo è un ottimo lavoro per position: sticky e un po' di overscroll-behavior.

Aggiungi i seguenti stili per la navigazione laterale:

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

Questi stili assicurano che la barra di navigazione laterale abbia l'altezza dell'area visibile, scorra verticalmente e contenga lo scorrimento. Inoltre, nasconde l'elemento. Per impostazione predefinita, quando l'area visibile è 540px o più piccola, nascondi la navigazione laterale. A meno che…

Aggiungi uno pseudoselettore :target all'elemento #sidenav-open:

#sidenav-open {

  @media (max-width: 540px) {

    &:target {
      visibility: visible;
    }
  }
}

Quando l'ID dell'elemento e la barra degli URL sono uguali, imposta visibility su visible. Apri il menu laterale dopo aver fatto scorrere la pagina o prova a far scorrere la pagina mentre il menu laterale è aperto. Cosa ne pensi?

Aggiungi il seguente CSS in fondo a app/sidenav.css:

#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;
  }
}

Questi stili hanno come target i pulsanti di apertura e chiusura, specificano i relativi stili di tocco e li nascondono anche quando le aree visibili sono di 540px o più grandi.

Per dare un tocco di stile, aggiungiamo le trasformazioni CSS con un'accessibilità rispettosa. Aggiungi il seguente CSS a css/sidenav.css:

#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;
  }
}
Una demo dell'interazione con e senza durata applicata in base alla query supporti "prefers-reduced-motion".

Aggiungi un po' di JavaScript

Il tasto Escape dovrebbe chiudere il menu. Aggiungi questo codice JS a js/index.js:

const sidenav = document.querySelector('#sidenav-open');

sidenav.addEventListener('keyup', e => {
  if (e.code === 'Escape') {
    document.location.hash = '';
  }
});

In questo modo, viene ascoltato un evento chiave sull'elemento sidenav. Se è Escape, imposta l'hash dell'URL su vuoto, in modo che la navigazione laterale venga disattivata.

Il prossimo elemento di UX JS è la gestione dello stato attivo. Voglio semplificare l'apertura e la chiusura, quindi aspetto che la navigazione laterale abbia completato una transizione di qualche tipo, poi la confronto con l'hash dell'URL per determinare se è dentro o fuori. Poi utilizzo JavaScript per impostare lo stato attivo sul pulsante complementare a quello appena premuto.

Aggiungi il seguente codice JavaScript a js/index.js:

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();
});

Prova

  • Per visualizzare l'anteprima del sito, premi Visualizza app, quindi premi Schermo intero schermo intero.

Conclusione

Questo è un riepilogo delle esigenze che avevo con il componente. Sentiti libero di svilupparlo, di gestirlo con lo stato JavaScript anziché con l'URL e, in generale, di personalizzarlo. C'è sempre qualcosa da aggiungere o altri casi d'uso da coprire.

Apri css/brandnav.css per controllare gli stili non correlati al layout che ho applicato a questo componente. Non ritenevo che fosse importante per l'insieme di funzionalità su cui mi stavo concentrando e speravo che la separazione degli stili dal layout avrebbe incoraggiato l'operazione di copia e incolla. Potresti trovare altre informazioni utili.

Come si creano componenti di navigazione laterale adattabili a scomparsa? Ti capita mai di averne più di uno, ad esempio uno su entrambi i lati? Mi piacerebbe presentare la tua soluzione in un video di YouTube, quindi assicurati di scrivermi su X o di commentare su YouTube con il tuo codice, sarà utile per tutti.