Ćwiczenia z programowania: tworzenie komponentu Sidenav

Z tego ćwiczenia dowiesz się, jak utworzyć komponent układu wysuwanego bocznego panelu nawigacyjnego w internecie. Będziemy tworzyć komponent krok po kroku, zaczynając od HTML, potem CSS, a na końcu JavaScript.

Przeczytaj mój post na blogu Tworzenie komponentu Sidenav, aby dowiedzieć się, jakie funkcje platformy internetowej CSS zostały wybrane do utworzenia tego komponentu.

Konfiguracja

  1. Kliknij Zremiksuj, aby edytować, aby umożliwić edytowanie projektu.
  2. Otwórz pokój app/index.html.

HTML

Najpierw zapoznaj się z podstawami konfiguracji HTML, aby mieć treści i pola, na których możesz pracować.

Wklej ten kod HTML do tagu <body>.

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

Element <aside> zawiera menu nawigacyjne jako element uzupełniający elementu <main>, który zawiera główną treść strony.

Następnie wypełnimy te elementy semantyczne pozostałą zawartością strony.

Dodaj element nawigacyjny, kilka linków nawigacyjnych i link zamykający wewnątrz elementu <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>

Linki świetnie sprawdzają się w elementach <nav>, a elementy <nav> – na paskach bocznych <aside>. Nadal jednak możemy coś ulepszyć.

W głównym elemencie treści dodaj nagłówek i artykuł, aby semantycznie przechowywać zawartość układu.

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

W nagłówku znajduje się link do otwarcia menu. W panelu bocznym znajduje się przycisk zamykania. Wkrótce będziemy wyświetlać i ukrywać elementy na podstawie rozmiaru widocznego obszaru.

W elemencie <article> wkleiliśmy zdanie zastępcze. Zastąp `` własnymi treściami lub wklej tekst lorem podany poniżej:

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

Ta treść i jej długość sprawią, że strona będzie przewijalna, gdy przekroczy wysokość widocznego obszaru.

Do tej pory dodaliśmy element aside z elementem nav, linkami i sposobem na zamknięcie bocznego paska nawigacyjnego. Dodano też nagłówek, sposób otwierania panelu bocznego i artykuł do elementu głównego. Jest to przejrzyste, semantyczne i ponadczasowe, ale możemy sprawić, że będzie jeszcze bardziej przejrzyste i czytelne dla wszystkich. Link do otwarcia w panelu bocznym mógłby być wyraźniej oznaczony.

Dodaj atrybuty title i aria-label do elementu linku otwierającego nagłówek:

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

Ikona otwartego pliku SVG mogłaby być również wyraźniej oznaczona. Dodaj te atrybuty do elementu SVG w otwartym elemencie linku:

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

Link do zamknięcia w panelu bocznym mógłby być wyraźniej oznaczony. Dodaj atrybuty title i aria-label do elementu linku zamykającego boczny panel nawigacyjny:

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

CSS

Czas na ułożenie elementów. Główna treść i boczny panel nawigacyjny są bezpośrednimi elementami podrzędnymi tagu <body>, więc to dobre miejsce na początek.

Dodaj do css/sidenav.css ten kod CSS, aby element <body> rozmieszczał elementy podrzędne.

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

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

Ten układ oznacza: utwórz nazwany wiersz stack ze wszystkimi elementami i 2 kolumnami, z których druga również ma nazwę stack. Pierwsza kolumna powinna być dopasowana do minimalnych potrzeb związanych z zawartością, a druga może zajmować resztę miejsca. Następnie, jeśli w ograniczonym widoku o rozmiarze 540px lub mniejszym, umieść elementy bocznego paska nawigacyjnego i głównej treści w tym samym wierszu i kolumnie, tak aby znajdowały się jeden nad drugim w siatce 1 x 1.

Dzięki tej funkcji responsywnego układu możemy teraz wykorzystać stan paska adresu URL do przełączania widoczności i stylu przejścia bocznego paska nawigacyjnego.

Zaktualizuj element <aside> w pliku app/index.html:

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

Dzięki temu CSS może dopasować element i skrót adresu URL. Jest to ważne w przypadku korzystania z :target. Teraz identyfikator elementu może być zgodny z hashem adresu URL, który ustawimy za pomocą tagów <a>.

Aby ułatwić kierowanie za pomocą JavaScriptu, dodaj też identyfikatory kluczowych elementów, które sterują bocznym panelem nawigacyjnym. Najpierw dodaj identyfikator do linku otwierającego boczny panel nawigacyjny:

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

Następnie dodaj identyfikator do linku zamykającego panel boczny:

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

To kończy makro <body> responsywnego układu stosu i łączy nas z paskiem adresu URL. Przejdźmy dalej.

<aside> ma też przejrzysty układ. Ma 2 elementy podrzędne: <nav>, który jest wysuwanym komponentem przypominającym papier, oraz zamykający element linku <a>, który ustawia adres URL na #. Link jest niewidoczny po prawej stronie wysuwanego menu nawigacyjnego. Dzięki temu użytkownicy mogą „kliknąć” komponent wizualny, aby go zamknąć.

Dodaj do pliku css/sidenav.css ten kod CSS:

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

Myślę, że proporcje i nazwy są tu bardzo przydatne, ponieważ siatka może się sprawdzić i dać projektantowi dużą kontrolę.

Następnie muszę warunkowo nałożyć główną treść i zachować moją pozycję podczas przewijania dokumentu. To świetne zadanie dla position: sticky i overscroll-behavior.

Dodaj te style do paska bocznego:

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

Te style zapewniają, że panel boczny ma wysokość widocznego obszaru, przewija się w pionie i zawiera pasek przewijania. Co bardzo ważne, ukrywa element. Domyślnie, gdy widoczny obszar ma rozmiar 540px lub mniejszy, ukryj ten boczny panel nawigacyjny. Chyba że…

Dodaj pseudoselektor :target do elementu #sidenav-open:

#sidenav-open {

  @media (max-width: 540px) {

    &:target {
      visibility: visible;
    }
  }
}

Jeśli identyfikator tego elementu i pasek adresu URL są takie same, ustaw visibility na visible. Otwórz menu boczne po przewinięciu strony lub spróbuj przewinąć stronę, gdy menu boczne jest otwarte. Co myślisz?

Dodaj ten kod CSS na dole pliku 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;
  }
}

Te style są przeznaczone dla przycisków otwierania i zamykania, określają ich style kliknięcia i dotknięcia, a także ukrywają je, gdy widoczny obszar ma co najmniej 540px.

Aby dodać trochę stylu, dodajmy przekształcenia CSS z zachowaniem ułatwień dostępu. Dodaj do pliku css/sidenav.css ten kod 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;
  }
}
Prezentacja interakcji z czasem trwania i bez niego na podstawie zapytania o media `prefers-reduced-motion`.

Dodawanie JavaScriptu

Klawisz Escape powinien zamykać menu. Dodaj ten kod JS do pliku js/index.js:

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

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

To ustawienie nasłuchuje kluczowego zdarzenia w elemencie sidenav. Jeśli jest to Escape, ustawia pusty URL, co powoduje przejście do bocznego paska nawigacyjnego.

Kolejny element kodu JS dotyczący UX to zarządzanie fokusem. Chcę, aby otwieranie i zamykanie było łatwe, więc czekam, aż panel boczny zakończy przejście, a następnie sprawdzam, czy jest on otwarty czy zamknięty, porównując go z hashem adresu URL. Następnie używam JavaScriptu, aby ustawić zaznaczenie na przycisku, który uzupełnia ten, który właśnie został naciśnięty.

Dodaj do js/index.js ten kod JavaScript:

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

Wypróbuj

  • Aby wyświetlić podgląd witryny, naciśnij Wyświetl aplikację, a następnie Pełny ekran pełny ekran.

Podsumowanie

To wszystko, czego potrzebowałem od tego komponentu. Możesz go rozbudować, sterować nim za pomocą stanu JavaScriptu zamiast adresu URL i ogólnie dostosować go do swoich potrzeb. Zawsze można dodać więcej informacji lub uwzględnić więcej przypadków użycia.

Otwórz plik css/brandnav.css, aby sprawdzić style niezwiązane z układem, które zastosowałem do tego komponentu. Nie uważałem, że jest to ważne dla zestawu funkcji, na którym się skupiałem, i miałem nadzieję, że oddzielenie stylów od układu zachęci do kopiowania i wklejania. Może znajdziesz tam coś ciekawego.

Jak utworzyć wysuwane, elastyczne komponenty bocznego paska nawigacyjnego? Czy zdarza się, że masz więcej niż 1, np. po obu stronach? Chętnie zaprezentuję Twoje rozwiązanie w filmie na YouTube. Wyślij mi tweeta lub dodaj komentarz w YouTube ze swoim kodem, aby pomóc innym.