跳到内容
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>
  )
}

须知:

  • 由于 useSelectedLayoutSegments 是一个 客户端组件 Hook,并且布局默认是 服务器组件,因此 useSelectedLayoutSegments 通常通过导入到布局中的客户端组件来调用。
  • 返回的段包括 路由组,你可能不希望将其包含在你的 UI 中。你可以使用 filter() 数组方法来删除以括号开头的项目。

参数

const segments = useSelectedLayoutSegments(parallelRoutesKey?: string)

useSelectedLayoutSegments 可选地 接受一个 parallelRoutesKey,它允许你读取该插槽内的活动路由段。

返回值

useSelectedLayoutSegments 返回一个字符串数组,其中包含从调用 Hook 的布局下一级的活动段。如果不存在,则返回一个空数组。

例如,给定以下布局和 URL,返回的段将是

布局访问的 URL返回的段
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