getMenu() の引数とメニュー項目の読み方

メニューの識別名から、リンクの表示名・移動先・子項目を読みます。メニューが見つからないときの戻り値も確認できます。

目次

管理画面で編集するナビゲーションを取得する関数が getMenu() です。練習サイトの「ヘッダーメニュー」は getMenu('primary') で読めます。

引数

引数指定例用途
第1引数(必須)'primary'メニューの識別名。管理画面に表示する日本語の名前とは別に設定します
第2引数(省略可){ locale: 'ja' }複数言語のメニューから取得したい言語を指定します

戻り値

await で取得を待つと、メニューが読み出せます。練習サイトで存在しない識別名を渡したときは null が返りました。

読む場所練習サイトの例用途
menu.labelヘッダーメニューメニュー全体の名前
menu.items2件の項目を含む配列最上位の項目を管理画面で並べた順に読む
item.label / item.url記事一覧 / /cards/リンクに表示する文字と移動先
item.target未指定、または _blank などリンクをどのタブで開くか
item.children子項目のない項目では []その項目の下に置いたリンクを読む

最上位のリンクを並べる

「週末ノート」を準備する手順で、メニュー primary と2件のリンクが登録されます。

練習サイトの src/pages/menu-sample.astro に書く例です。/menu-sample/ を開くと「記事一覧」と「10件ずつ読む」が並びます。

---
import { getMenu } from 'emdash';

const menu = await getMenu('primary');
const items = menu?.items ?? [];
---
{items.length > 0 && (
  <nav aria-label="メインメニュー">
    <ul>
      {items.map(item => (
        <li>
          <a href={item.url} target={item.target}
             rel={item.target === '_blank' ? 'noopener noreferrer' : undefined}>
            {item.label}
          </a>
        </li>
      ))}
    </ul>
  </nav>
)}

menu?.items ?? [] と書くと、メニューが見つからない場合も空の配列として扱えます。子項目も見せるデザインなら、各 li の中で item.children を順に表示します。並び順を実際に変えて試すには管理画面でメニューを並べ替える実習へ進んでください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。