程式碼研究室:建構 Sidenav 元件

本程式碼研究室會說明如何在網頁上建構回應式側邊滑出式導覽版面配置元件。我們會逐步建構元件,先從 HTML 開始,接著是 CSS,然後是 JavaScript。

請參閱我的網誌文章「建構 Sidenav 元件」,瞭解建構這個元件時選擇的 CSS 網頁平台功能。

設定

  1. 按一下「重混即可編輯」,即可編輯專案。
  2. 開啟 app/index.html。

HTML

首先,請取得 HTML 設定的基本要素,以便處理內容和一些方塊。

將下列 HTML 程式碼放入 <body> 標記。

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

<aside> 包含導覽選單,做為 <main> 的補充元素,後者則包含主要頁面內容。

接下來,我們將在這些語意元素中填入網頁的其他內容。

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

連結很適合放在 <nav> 元素中,而 <nav> 元素很適合放在 <aside> 側欄中。不過,我們仍有許多改進空間。

在主要內容元素中,新增標頭和文章,以語意方式保留版面配置內容。

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

標頭含有開啟選單的連結。aside 含有關閉按鈕。我們很快就會根據可視區域大小顯示及隱藏元素。

在 <article> 元素中,我們貼上了預留位置句子。將 `` 替換為您自己的內容,或貼上下方提供的 lorem:

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

當內容長度超過可視區域高度時,網頁就會變成可捲動。

到目前為止,您已新增 aside 元素,其中包含 nav、連結和關閉側邊導覽列的方法。您也新增了標頭、開啟側邊導覽的方式,以及主要元素的文章。 這段程式碼簡潔、語意明確,而且相當經典,但我們可以讓它更簡潔、更清楚。側邊導覽列中的開啟連結 可以更清楚標示

在標頭開啟連結元素中加入 title 和 aria-label 屬性:

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

此外,開啟 SVG 的圖示也可以標示得更清楚。在開啟連結元素內的 SVG 中,加入下列屬性:

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

側邊導覽列中的關閉連結可以標示得更清楚。 在側邊導覽關閉 link 元素中,加入 title 和 aria-label 屬性:

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

CSS

現在要安排元素的版面配置。主要內容和側邊導覽是 <body> 標記的直接子項,因此很適合從這裡開始。

將下列 CSS 新增至 css/sidenav.css,讓 <body> 元素能配置子項。

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

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

這個版面配置基本上表示:建立名為 stack 的資料列,其中包含所有內容,以及該資料列中的 2 個資料欄,其中第 2 個資料欄也名為 stack。第 1 欄應根據最小內容需求調整大小,第 2 欄則可佔用其餘空間。接著,如果可視區域受限於 540px 以下,請將側邊導覽和主要內容元素放入同一列和同一欄,使其在 1x1 網格中重疊。

有了這個回應式堆疊功能做為基礎,我們現在可以利用網址列的狀態,切換側邊導覽列的顯示設定和轉場樣式。

在 app/index.html 中更新 <aside> 元素:

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

這樣一來,CSS 就能同時比對元素和網址雜湊。這對 :target 的使用至關重要。現在,元素的 ID 可以與我們使用 <a> 標記設定的網址雜湊相符。

此外,為了更輕鬆地指定 JavaScript,請為控制側邊導覽列的重要元素新增 ID。首先,在側邊導覽開啟連結中新增 ID:

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

接著,在側邊導覽關閉連結中新增 ID:

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

以上就是巨集 <body> 回應式堆疊版面配置的介紹,以及如何與網址列連結。接著執行下一項工作吧!

<aside> 的版面配置也很簡潔。它有 2 個子項,一個是 <nav>,這是滑出的紙張狀元件,另一個是關閉 <a> link 元素,將網址設為 #。連結位於紙張滑出導覽列右側,但不會顯示;這樣一來,使用者就能「點選」視覺元件來關閉。

在 css/sidenav.css 中加入下列 CSS:

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

我認為這裡的比例和名稱非常棒,網格可以發揮作用,讓設計師擁有很大的控制權。

接下來,我需要根據條件疊加主要內容,並在捲動文件時保持位置不變。這項工作非常適合 position: sticky 和部分 overscroll-behavior。

為側邊導覽新增下列樣式:

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

這些樣式可確保側邊導覽列的高度與可視區域相同、可垂直捲動,且包含捲軸。最重要的是,它會隱藏元素。根據預設,當可視區域為 540px 或更小時,系統會隱藏該側邊導覽。除非!

在 #sidenav-open 元素中新增 :target 虛擬選取器:

#sidenav-open {

  @media (max-width: 540px) {

    &:target {
      visibility: visible;
    }
  }
}

如果該元素的 ID 和網址列相同,請將 visibility 設為 visible。請在捲動頁面後開啟側邊選單,或在側邊導覽列開啟時捲動頁面。結果如何?

在 app/sidenav.css 底部加入下列 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;
  }
}

這些樣式會指定開啟和關閉按鈕的輕觸和觸控樣式,並在可視區域為 540px 以上時隱藏這些按鈕。

為了增添一些風格,我們來新增 CSS 轉換,並考量無障礙功能。在 css/sidenav.css 中加入下列 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;
  }
}
根據 `prefers-reduced-motion` 媒體查詢,示範套用和未套用持續時間的互動。

加入一些 JavaScript

Escape 鍵應可關閉選單。將這個 JS 新增至 js/index.js:

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

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

這會監聽側邊導覽元素上的按鍵事件。如果是 Escape,則會將網址雜湊設為空白,讓側邊導覽列轉場消失。

下一個使用者體驗 JS 是焦點管理。我想讓開啟和關閉變得簡單,因此我會等到側邊導覽完成某種轉場效果,然後與網址雜湊交叉檢查,判斷是否在其中。接著,我使用 JavaScript 將焦點設定在與使用者剛按下的按鈕互補的按鈕上。

將下列 JavaScript 新增至 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();
});

試試看

  • 如要預覽網站,請按下「View App」,然後按下「Fullscreen」全螢幕。

結論

以上就是我對這個元件的需求。歡迎以此為基礎,使用 JavaScript 狀態 (而非網址) 驅動,並根據需求進行調整!總是有更多內容可以新增,或更多用途可以涵蓋。

開啟 css/brandnav.css,查看我套用至這個元件的非版面配置相關樣式。我認為這對我著重的特徵集並不重要,而且我希望將樣式與版面配置分開,能鼓勵複製及貼上。或許能學到更多知識!

如何製作滑出式回應式側邊導覽元件?你是否曾同時有超過 1 個,例如兩邊各有一個?我很樂意在 YouTube 影片中介紹你的解決方案,請務必在 Twitter 上標記我,或在 YouTube 留言中附上你的程式碼,這對大家很有幫助!