カタログを見る
カタログは dev サーバーの /__zukan/ で開きます(base を設定しているときは <base>__zukan/)。このページでは、トップページ、コンポーネントの探し方、テーマ、キーボードショートカットを説明します。各プレビューには専用のツールバーがあり、アクセシビリティパネルもそこから開きます。
トップページ
コンポーネントごとに、最初のセクションの小さなプレビュー、名前とディレクトリ、.md ファイルの最初の段落を載せたカードが並びます。セクションのないコンポーネントでは、プレビューの代わりに頭文字を表示します。カードをクリックすると詳細ページを開きます。
プロジェクトで Tailwind CSS を使っているときは、Tailwind CSS のエントリーごとのカードが最初に並びます。テーマの色を並べた帯が付いていて、クリックするとそのページを開きます。
カードの下には、探索するディレクトリにある .svelte ファイルのうち、隣にまだカタログファイルがないものを畳んだ一覧で出します。カタログにまだ載せていないものが分かります。SvelteKit のルートのファイル(+page.svelte)、テスト用のコンポーネント、Storybook と Histoire のストーリー(*.stories.svelte、*.story.svelte)、src/routes/ は含めません。
コンポーネントを探す
- サイドバーには、コンポーネントがグループとディレクトリごとに並びます。フォルダーは開閉でき、矢印キーで一覧を移動できます
- 検索欄に入力すると、ID とセクション名で絞り込みます。一致したセクション名は各コンポーネントの下に並び、そのセクションへ直接移れます
- もっと広く探すときは、⌘ K(Windows と Linux では Ctrl K)を押すか、サイドバー上部の虫眼鏡をクリックします。対象は、コンポーネントの名前と ID、セクション名、各
.mdファイルの本文、Props の名前と説明です。Tailwind CSS を使っているときは、トークンも対象です。カテゴリー名、クラス名、テーマ変数が探せ、クラス名や変数の結果を開くと、そのカテゴリーがそのトークンで絞り込まれて表示されます。結果は一致した場所ごとにまとまり、説明で一致したものには前後の文が付きます。上のボタンで、探すグループを 1 つに絞れます。↑ ↓ で結果を選び、Enter で開き、Esc で閉じます - セクションが複数ある詳細ページでは、画面の幅に余裕があれば横に目次が出ます。Props があるときは、目次の先頭が Props の一覧へのリンクになります。Props の一覧は説明のすぐ下にあります。ページの下には前後のコンポーネントへのリンクがあります
- dev サーバーでは、詳細ページのタイトルの下に、カタログファイルとコンポーネントをエディターで開くボタンがあります。Vite 自身のエディターで開く仕組みを使うので、開くエディターは環境変数
LAUNCH_EDITORで選べます。静的に書き出したカタログには、このボタンはありません - 狭い画面では、コンポーネントの一覧がメニューボタンの中に畳まれます
テーマ
サイドバー上部のテーマボタンで、カタログとすべてのプレビューをライトとダークで切り替えます。最初は OS の設定に合わせ、選んだテーマはこのブラウザーで保たれます。テーマは各プレビューの color-scheme になるので、コンポーネントの light-dark() や prefers-color-scheme もこれに従います。単独で開いたセクションはフレームの中にないので、light-dark() はテーマに従いますが、prefers-color-scheme はブラウザーに従います。これを使うスタイルシート(Tailwind の標準の dark: バリアントなど)は、そこではライトのまま表示されることがあります。
テーマを 1 つに決めたいときは、theme オプションに 'light' か 'dark' を指定します。カタログとすべてのプレビューが常にそのテーマになり、テーマボタンと T のショートカットはなくなります。
キーボードショートカット
| キー | 動作 |
|---|---|
| / | 検索欄に移る |
| ⌘ K | 名前・セクション・Props・説明から探す(Windows と Linux では Ctrl K) |
| J / K | 次 / 前のコンポーネント |
| T | ライトとダークを切り替える(theme オプションの指定時は使えない) |
| F | 表示中のプレビューを拡大する(もう一度で戻る) |
| Esc | 拡大したプレビューから戻る |
| ↑ ↓ | コンポーネントの一覧を移動する |
| ← → | 一覧のフォルダーを閉じる・開く |
| ? | ショートカットの一覧を出す |
ショートカットはフォーカスがプレビューの中にあっても働きますが、検索欄などに入力している間は働きません。ただし、入力欄でも ⌘ K だけは働きます。
ページで最初に Tab を押すと「本文へスキップ」のリンクが現れ、サイドバーを飛ばして本文へフォーカスを移せます。