useSelectedLayoutSegment
useSelectedLayoutSegment
は、呼び出し元のレイアウトの1階層下にあるアクティブなルートセグメントを読み取ることができるクライアントコンポーネント用フックです。
親レイアウト内のタブなど、アクティブな子セグメントに応じてスタイルを変更するナビゲーションUIに便利です。
知っておくと便利:
useSelectedLayoutSegment
はクライアントコンポーネント用フックであり、レイアウトはデフォルトでサーバーコンポーネントであるため、通常はレイアウトにインポートされたクライアントコンポーネントから呼び出されます。useSelectedLayoutSegment
は1階層下のセグメントのみを返します。すべてのアクティブなセグメントを取得するには、useSelectedLayoutSegments
を使用してください。
パラメータ
useSelectedLayoutSegment
はオプションでparallelRoutesKey
を受け取り、指定したスロット内のアクティブなルートセグメントを読み取ることができます。
戻り値
useSelectedLayoutSegment
はアクティブなセグメントの文字列を返します。存在しない場合はnull
を返します。
例えば、以下のレイアウトとURLの場合、返されるセグメントは次のようになります:
レイアウト | アクセスしたURL | 返されるセグメント |
---|---|---|
app/layout.js | / | null |
app/layout.js | /dashboard | 'dashboard' |
app/dashboard/layout.js | /dashboard | null |
app/dashboard/layout.js | /dashboard/settings | 'settings' |
app/dashboard/layout.js | /dashboard/analytics | 'analytics' |
app/dashboard/layout.js | /dashboard/analytics/monthly | 'analytics' |
使用例
アクティブなリンクコンポーネントの作成
useSelectedLayoutSegment
を使用して、アクティブなセグメントに応じてスタイルを変更するリンクコンポーネントを作成できます。例えば、ブログのサイドバーにある注目記事リスト:
バージョン履歴
バージョン | 変更内容 |
---|---|
v13.0.0 | useSelectedLayoutSegment が導入されました。 |