跳至內容
API 參考函式useSelectedLayoutSegments

使用選取的佈局區段們 (useSelectedLayoutSegments)

useSelectedLayoutSegments 是一個客戶端元件 hook,可讓您讀取呼叫它的佈局下方的有效路由區段。

它適用於在需要知道有效子區段(例如麵包屑)的父佈局中建立 UI。

app/example-client-component.tsx
'use client'
 
import { useSelectedLayoutSegments } from 'next/navigation'
 
export default function ExampleClientComponent() {
  const segments = useSelectedLayoutSegments()
 
  return (
    <ul>
      {segments.map((segment, index) => (
        <li key={index}>{segment}</li>
      ))}
    </ul>
  )
}

注意事項 (Good to know):

參數

const segments = useSelectedLayoutSegments(parallelRoutesKey?: string)

useSelectedLayoutSegments 可以選擇性地接受一個 parallelRoutesKey 參數,讓您可以讀取該位置中的活動路由區段。

回傳值

useSelectedLayoutSegments 會返回一個字串陣列,其中包含從呼叫此 hook 的佈局下一層的活動區段。如果不存在,則返回一個空陣列。

例如,根據以下佈局和網址,返回的區段將會是

佈局已造訪的網址返回的區段
app/layout.js/[]
app/layout.js/dashboard['dashboard']
app/layout.js/dashboard/settings['dashboard', 'settings']
app/dashboard/layout.js/dashboard[]
app/dashboard/layout.js/dashboard/settings['settings']

版本歷史記錄

版本變更
v13.0.0引進 useSelectedLayoutSegments