Codelab: Sidenav コンポーネントをビルドする

この Codelab では、ウェブ上でレスポンシブなスライドアウト サイド ナビゲーション レイアウト コンポーネントを構築する方法について説明します。コンポーネントは、HTML、CSS、JavaScript の順に作成していきます。

このコンポーネントの構築に選択された CSS ウェブ プラットフォームの機能については、ブログ投稿「Sidenav コンポーネントの構築」をご覧ください。

セットアップ

  1. [Remix to Edit] をクリックして、プロジェクトを編集可能にします。
  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 要素を追加しました。 また、ヘッダー、サイドナビを開く方法、記事をメイン要素に追加しました。 これはクリーンで、セマンティックで、すでにかなり時代を超越していますが、誰にとってもよりクリーンで明確にすることができます。サイドナビの開くリンクは、より明確にマークできます。

ヘッダーのリンク要素開始タグに 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">

サイドナビの閉じるリンクをより明確に表示できます。 sidenav の閉じるリンク要素に title 属性と aria-label 属性を追加します。

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

CSS

要素をレイアウトします。メイン コンテンツとサイドナビは <body> タグの直接の子であるため、ここから始めるのが適切です。

<body> 要素が子要素をレイアウトするように、次の CSS を css/sidenav.css に追加します。

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 グリッドで互いに重なるようにします。

このレスポンシブなスタック機能をベースとして、URL バーの状態を利用して、サイドナビの表示 / 非表示と遷移スタイルを切り替えることができます。

app/index.html の <aside> 要素を更新します。

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

これにより、CSS で要素と URL ハッシュを照合できます。これは :target の使用において重要です。これで、要素の ID が、<a> タグで設定する URL ハッシュと一致するようになります。

また、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> のレスポンシブな積み重ねレイアウトが完成し、URL バーにも接続されました。 先に進みましょう。

<aside> のレイアウトもすっきりしています。この要素には 2 つの子要素があります。1 つは <nav> で、これはスライドアウトする紙のようなコンポーネントです。もう 1 つは <a> リンク要素で、これは URL ハッシュを # に設定します。このリンクは、用紙のスライドアウト ナビゲーションの右側に表示されません。これは、ユーザーがビジュアル コンポーネントを「クリック」して閉じることができるようにするためです。

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 と URL バーが同じ場合は、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 = '';
  }
});

これは、sidenav 要素のキーイベントをリッスンします。 Escape の場合は、URL ハッシュを空に設定して、サイドナビを閉じます。

次の UX JS はフォーカス管理です。開閉を簡単にするために、サイドナビが何らかの遷移を完了するまで待ってから、URL ハッシュと照合して、開いているか閉じているかを判断します。次に、JavaScript を使用して、ユーザーが押したボタンを補完するボタンにフォーカスを設定します。

js/index.js に次の 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();
});

試してみる

  • サイトをプレビューするには、[View App] を押します。次に、[Fullscreen] 全画面表示 を押します。

まとめ

コンポーネントに関するニーズは以上です。このコードをベースに、URL ではなく JavaScript の状態を使用して、独自のコードを作成してください。追加すべきことや 対応すべきユースケースは常にあります

css/brandnav.css を開いて、このコンポーネントに適用したレイアウト以外のスタイルを確認します。私が重視していた機能セットにとって重要ではないと感じていたこと、そして、スタイルをレイアウトから分離することで、コピーして貼り付けが促進されることを期待していたことが理由です。さらに多くのことを学べるかもしれません。

スライドアウトするレスポンシブなサイドナビ コンポーネントを作成するにはどうすればよいですか?2 つ以上(両側に 1 つずつなど)あることはありますか?皆さんのソリューションを YouTube 動画で紹介したいので、ぜひツイートするか、YouTube にコメントしてコードを共有してください。