このページは Cloud Translation API によって翻訳されました。

パンくずリストコンポーネントの作成

ユーザーがサイトを移動できるように、レスポンシブでアクセス可能なパンくずリストコンポーネントを作成する方法の基本的な概要。

Adam Argyle

この記事では、パンくずリストコンポーネントを作成する方法について考えたいと思います。デモを試す

デモ

動画で確認したい場合は、YouTube 版の投稿をご覧ください。

概要

パンくずリストコンポーネントは、ユーザーがサイト階層内のどこにいるかを示します。この名前は、暗い森の中でパンくずを落として、後ろからパンくずをたどって家を見つけたハンセルとグレーテルに由来しています。

この投稿のパンくずリストは標準のパンくずリストではなく、パンくずのようなものです。また、<select> を使用して兄弟ページをナビゲーションに直接配置することで機能を追加し、多層アクセスを可能にします。

バックグラウンド UX

上記のコンポーネントのデモ動画では、プレースホルダのカテゴリはビデオゲームのジャンルです。このトレイルは、次のようにパス home » rpg » indie » on sale をナビゲートして作成されます。

このパンくずリストコンポーネントは、ユーザーがこの情報階層を移動し、ブランチをジャンプして、迅速かつ正確にページを選択できるようにする必要があります。

情報アーキテクチャ

コレクションとアイテムの観点から考えると役に立つと思います。

コレクション

コレクションは、選択可能なオプションの配列です。この投稿のパンくずリストプロトタイプのホームページには、FPS、RPG、ブラウラー、ダンジョンクローラー、スポーツ、パズルのコレクションが含まれています。

アイテム

動画ゲームはアイテムであり、特定のコレクションが別のコレクションを表す場合は、そのコレクションもアイテムになります。たとえば、RPG はアイテムであり、有効なコレクションです。アイテムの場合は、ユーザーがそのコレクションページにいます。たとえば、RPG ページには、AAA、インディー、セルフパブリッシュなどのサブカテゴリを含む RPG ゲームのリストが表示されます。

コンピュータサイエンスの用語では、このパンくずリストコンポーネントは多次元配列を表します。

const rawBreadcrumbData = {
  "FPS": {...},
  "RPG": {
    "AAA": {...},
    "indie": {
      "new": {...},
      "on sale": {...},
      "under 5": {...},
    },
    "self published": {...},
  },
  "brawler": {...},
  "dungeon crawler": {...},
  "sports": {...},
  "puzzle": {...},
}

アプリまたはウェブサイトでは、カスタム情報アーキテクチャ（IA）によって異なる多次元配列が作成されますが、コレクションのランディングページと階層トラバーサルのコンセプトをパンくずリストに組み込むこともできます。

レイアウト

マークアップ

優れたコンポーネントは、適切な HTML から始まります。次のセクションでは、マークアップの選択と、それがコンポーネント全体に与える影響について説明します。

ダーク&ライトスキーム

<meta name="color-scheme" content="dark light">

上記のスニペットの color-scheme メタタグは、このページが明るいブラウザスタイルと暗いブラウザスタイルを希望していることをブラウザに通知します。サンプルのパンくずリストには、これらのカラーパターンの CSS が含まれていないため、パンくずリストにはブラウザが提供するデフォルトの色が使用されます。

ナビゲーション要素

<nav class="breadcrumbs" role="navigation"></nav>

サイトナビゲーションには、暗黙的な ARIA ロール「navigation」を持つ <nav> 要素を使用するのが適切です。テストで、role 属性が設定されていると、スクリーンリーダーが要素を操作する方法が変更され、実際にはナビゲーションとして読み上げられることがわかったため、この属性を追加することにしました。

アイコン

ページ上でアイコンが繰り返される場合、SVG <use> 要素を使用すると、path を 1 回定義して、アイコンのすべてのインスタンスで使用できます。これにより、同じパス情報が繰り返されることがなくなり、ドキュメントのサイズが大きくなり、パスに不整合が生じる可能性があります。

この手法を使用するには、非表示の SVG 要素をページに追加し、一意の ID を持つ <symbol> 要素でアイコンをラップします。

<svg style="display: none;">

  <symbol id="icon-home">
    <title>A home icon</title>
    <path d="M3 12l2-2m0 0l7-7 7 7M5 10v10a1 1 0 001 1h3m10-11l2 2m-2-2v10a1 1 0 01-1 1h-3m-6 0a1 1 0 001-1v-4a1 1 0 011-1h2a1 1 0 011 1v4a1 1 0 001 1m-6 0h6"/>
  </symbol>

  <symbol id="icon-dropdown-arrow">
    <title>A down arrow</title>
    <path d="M19 9l-7 7-7-7"/>
  </symbol>

</svg>

ブラウザは SVG HTML を読み取り、アイコン情報をメモリに保存し、アイコンの追加使用のために ID を参照してページの残りの部分を処理します。

<svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true">
  <use href="#icon-home" />
</svg>

<svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true">
  <use href="#icon-dropdown-arrow" />
</svg>

レンダリングされた SVG use 要素を示す DevTools。

1 回定義すれば、ページのパフォーマンスへの影響を最小限に抑えながら、柔軟なスタイル設定で何度でも使用できます。SVG 要素に aria-hidden="true" が追加されていることに注目してください。このアイコンは、コンテンツを聴いているだけのブラウジングユーザーには役に立ちません。そのようなユーザーに対して非表示にすることで、不要なノイズの追加を防ぐことができます。

分割リンク `.crumb`

従来のパンくずリストとこのコンポーネントのパンくずリストの違いは、この点にあります。通常、これは <a> リンクのみですが、偽装された選択を使用して移動 UX を追加しました。.crumb クラスはリンクとアイコンの配置を担い、.crumbicon はアイコンと選択要素をスタックする役割を担います。ページナビゲーション用の分割ボタンに非常によく似ているため、分割リンクと呼んでいます。

<span class="crumb">
  <a href="#sub-collection-b">Category B</a>
  <span class="crumbicon">
    <svg>...</svg>
    <select class="disguised-select" title="Navigate to another category">
      <option>Category A</option>
      <option selected>Category B</option>
      <option>Category C</option>
    </select>
  </span>
</span>

リンクといくつかのオプションは特別なものではありませんが、シンプルなパンくずリストに機能を追加します。<select> 要素に title を追加すると、スクリーンリーダーを使用するユーザーがボタンのアクションに関する情報を把握するのに役立ちます。ただし、他のユーザーにも同じヘルプが表示されるため、iPad では中央に表示されます。1 つの属性で多くのユーザーにボタンのコンテキストを提供します。

非表示の選択要素にカーソルを合わせ、コンテキストツールチップを表示したスクリーンショット。

区切りの装飾

<span class="crumb-separator" aria-hidden="true">→</span>

区切り文字は省略可能です。1 つだけ追加しても問題ありません（上記の動画の 3 番目の例をご覧ください）。次に、各 aria-hidden="true" は装飾的であり、スクリーンリーダーが読み上げる必要のないものであるため、指定します。

次の gap プロパティを使用すると、これらの間隔を簡単に設定できます。

スタイル

色にはシステムカラーが使用されているため、ほとんどがスタイルのギャップとスタックです。

レイアウトの向きと流れ

フレックスボックスオーバーレイ機能を使用してパンくずリストのナビゲーションの配置を示す DevTools。

プライマリナビゲーション要素 nav.breadcrumbs は、子が使用するスコープ付きカスタムプロパティを設定します。設定しない場合、水平方向に垂直に配置されたレイアウトが確立されます。これにより、パンくずリスト、区切り線、アイコンが揃います。

.breadcrumbs {
  --nav-gap: 2ch;

  display: flex;
  align-items: center;
  gap: var(--nav-gap);
  padding: calc(var(--nav-gap) / 2);
}

1 つのパンくずリストが、フレックスボックスオーバーレイで垂直方向に表示されています。

各 .crumb は、一定の間隔を空けて水平方向に垂直に配置されたレイアウトも確立しますが、リンクの子を特別にターゲットに設定し、スタイル white-space: nowrap を指定します。複数の単語からなるパンくずリストは複数行に分割したくないため、これは非常に重要です。この投稿の後半では、この white-space プロパティによって発生した水平方向のオーバーフローを処理するスタイルを追加します。

.crumb {
  display: inline-flex;
  align-items: center;
  gap: calc(var(--nav-gap) / 4);

  & > a {
    white-space: nowrap;

    &[aria-current="page"] {
      font-weight: bold;
    }
  }
}

aria-current="page" は、現在のページのリンクを他のリンクから際立たせるために追加されます。スクリーンリーダーのユーザーには、リンクが現在のページのものであることを明確に示すインジケーターが表示されるだけでなく、視覚障がいのあるユーザーにも同様のユーザーエクスペリエンスを提供できるよう、要素の視覚的なスタイルも設定されています。

.crumbicon コンポーネントは、グリッドを使用して、「ほぼ見えない」<select> 要素と SVG アイコンを積み重ねます。

行と列の名前がどちらもスタックであるボタンに重ねて表示されたグリッド DevTools。

.crumbicon {
  --crumbicon-size: 3ch;

  display: grid;
  grid: [stack] var(--crumbicon-size) / [stack] var(--crumbicon-size);
  place-items: center;

  & > * {
    grid-area: stack;
  }
}

<select> 要素は DOM の最後にあるため、スタックの上部にあり、インタラクティブです。opacity: .01 のスタイルを追加して要素を引き続き使用できるようにし、アイコンの形状に完全にフィットする選択ボックスを作成します。これは、組み込み機能を維持しながら <select> 要素の外観をカスタマイズするのに適した方法です。

.disguised-select {
  inline-size: 100%;
  block-size: 100%;
  opacity: .01;
  font-size: min(100%, 16px); /* Defaults to 16px; fixes iOS zoom */
}

オーバーフロー

パンくずリストは非常に長い経路を表す必要があります。私は、必要に応じて画面外に水平展開できるようにしてほしいです。このパンくずリストコンポーネントは、最適だと感じています。

.breadcrumbs {
  overflow-x: auto;
  overscroll-behavior-x: contain;
  scroll-snap-type: x proximity;
  scroll-padding-inline: calc(var(--nav-gap) / 2);

  & > .crumb:last-of-type {
    scroll-snap-align: end;
  }

  @supports (-webkit-hyphens:none) { & {
    scroll-snap-type: none;
  }}
}

オーバーフロースタイルでは、次の UX が設定されます。

オーバースクロールコンテナを使用した水平スクロール。
水平スクロールのパディング。
最後のクランブルに 1 つのスナップポイント。つまり、ページの読み込み時に、最初のパンくずリストがスナップされてビューに読み込まれます。
Safari からスナップポイントを削除しました。これにより、横方向のスクロールとスナップエフェクトの組み合わせがスムーズに動作するようになります。

メディアクエリ

小さいビューポート向けの微妙な調整として、[ホーム] ラベルを非表示にしてアイコンのみを表示します。

@media (width <= 480px) {
  .breadcrumbs .home-label {
    display: none;
  }
}

比較のために、ホームラベルがある場合とない場合のパンくずリストを並べて表示しています。

ユーザー補助

モーション

このコンポーネントには多くのモーションはありませんが、遷移を prefers-reduced-motion チェックでラップすることで、不要な動きを防ぐことができます。

@media (prefers-reduced-motion: no-preference) {
  .crumbicon {
    transition: box-shadow .2s ease;
  }
}

他のスタイルはどれも変更する必要がありません。transition がなくてもホバー効果とフォーカス効果は最適で意味がありますが、モーションに問題がなければ、インタラクションに微妙な遷移を追加します。

JavaScript

まず、サイトまたはアプリで使用するルータータイプに関係なく、ユーザーがパンくずリストを変更したときに URL を更新し、適切なページをユーザーに表示する必要があります。2 つ目は、ユーザーエクスペリエンスを標準化するために、ユーザーが <select> オプションをブラウジングしているときに、予期しないナビゲーションが発生しないようにすることです。

JavaScript で処理する 2 つの重要なユーザーエクスペリエンス対策: 選択内容の変更と、<select> 変更イベントの早期トリガー防止。

<select> 要素を使用しているため、早期イベント防止が必要です。Windows Edge では、おそらく他のブラウザでも、ユーザーがキーボードでオプションをブラウジングすると、select changed イベントが発生します。ユーザーがホバーやフォーカスなどの疑似選択のみを行い、enter や click で選択を確認していないため、これを「早期」と呼んでいます。早期イベントを使用すると、このコンポーネントのカテゴリ変更機能にアクセスできなくなります。選択ボックスを開いてアイテムをブラウジングするだけで、ユーザーが準備する前にイベントが発生し、ページが変更されるためです。

`<select>` 変更イベントの改善

const crumbs = document.querySelectorAll('.breadcrumbs select')
const allowedKeys = new Set(['Tab', 'Enter', ' '])
const preventedKeys = new Set(['ArrowUp', 'ArrowDown'])

// watch crumbs for changes,
// ensures it's a full value change, not a user exploring options via keyboard
crumbs.forEach(nav => {
  let ignoreChange = false

  nav.addEventListener('change', e => {
    if (ignoreChange) return
    // it's actually changed!
  })

  nav.addEventListener('keydown', ({ key }) => {
    if (preventedKeys.has(key))
      ignoreChange = true
    else if (allowedKeys.has(key))
      ignoreChange = false
  })
})

この戦略では、各 <select> 要素のキーボードのダウンイベントを監視し、押されたキーがナビゲーションの確認（Tab または Enter）か空間ナビゲーション（ArrowUp または ArrowDown）かを判断します。この判断により、コンポーネントは <select> 要素のイベントが発生したときに、待機するか移動するかを決定できます。

まとめ

どのようにやり方をしたかわかったので、どのように感じますか？ ‽ 🙂?

手法を多様化して、ウェブで構築するすべての方法を学びましょう。デモを作成して、ツイートしてください。リンクを送信していただければ、下のコミュニティリミックスのセクションに追加します。

コミュニティリミックス

ウェブコンポーネントとしての Tux Solbakk: デモとコード