ページ内目次(ToC)のレンダリング
Methanol はページのコンパイル時に見出しを自動的に抽出し、ctx.page.toc に構造化されたデータとして格納します。
目次データの構造例:
{
depth: 2,
id: 'my-heading',
value: 'My heading',
children: []
}
シンプルな ToC レンダラーの実装
const Toc = ({ toc }) => {
if (!toc?.length) return null
return (
<nav aria-label="On this page">
<div>On this page</div>
<ul>
{toc.map((item) => (
<li>
<a href={`#${item.id}`}>{item.value}</a>
{item.children?.length ? <Toc toc={item.children} /> : null}
</li>
))}
</ul>
</nav>
)
}
export default function PageTemplate({ PageContent, ExtraHead, ctx }) {
return (
<>
<html>
<head>
<ExtraHead />
</head>
<body>
<main>
<PageContent />
</main>
<aside>
<Toc toc={ctx.page.toc} />
</aside>
</body>
</html>
</>
)
}
実装のアドバイス
- 多くのテーマでは、すべての見出しを表示するのではなく、特定のレベル(例: H2〜H4)のみを抽出して表示する制限を設けています。
- スクロール位置に連動して現在表示中のセクションを強調する「アクティブハイライト」機能を実装する場合は、クライアントコンポーネントによる実装が推奨されます。デフォルトテーマの
ThemeToCContainer.client.jsxが実装の参考になります。