跳到内容
API 参考函数useSelectedLayoutSegment

useSelectedLayoutSegment

useSelectedLayoutSegment 是一个客户端组件 Hook，允许您读取从其调用的布局下一级的活动路由段。

它对于导航 UI 非常有用，例如父布局内的选项卡，这些选项卡根据活动子段更改样式。

app/example-client-component.tsx
'use client'
 
import { useSelectedLayoutSegment } from 'next/navigation'
 
export default function ExampleClientComponent() {
  const segment = useSelectedLayoutSegment()
 
  return <p>Active segment: {segment}</p>
}

须知:

  • 由于 useSelectedLayoutSegment 是一个客户端组件 Hook，并且布局默认是服务器组件，因此 useSelectedLayoutSegment 通常通过导入到布局中的客户端组件来调用。
  • useSelectedLayoutSegment 仅返回下一级段。要返回所有活动段，请参阅 useSelectedLayoutSegments

参数 

const segment = useSelectedLayoutSegment(parallelRoutesKey?: string)

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

返回值

useSelectedLayoutSegment 返回活动段的字符串，如果不存在则返回 null。

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

布局访问的 URL返回的段
app/layout.js/null
app/layout.js/dashboard'dashboard'
app/dashboard/layout.js/dashboardnull
app/dashboard/layout.js/dashboard/settings'settings'
app/dashboard/layout.js/dashboard/analytics'analytics'
app/dashboard/layout.js/dashboard/analytics/monthly'analytics'

示例

您可以使用 useSelectedLayoutSegment 创建一个活动链接组件，该组件根据活动段更改样式。例如，博客侧边栏中的精选文章列表

app/blog/blog-nav-link.tsx
'use client'
 
import Link from 'next/link'
import { useSelectedLayoutSegment } from 'next/navigation'
 
// This *client* component will be imported into a blog layout
export default function BlogNavLink({
  slug,
  children,
}: {
  slug: string
  children: React.ReactNode
}) {
  // Navigating to `/blog/hello-world` will return 'hello-world'
  // for the selected layout segment
  const segment = useSelectedLayoutSegment()
  const isActive = slug === segment
 
  return (
    <Link
      href={`/blog/${slug}`}
      // Change style depending on whether the link is active
      style={{ fontWeight: isActive ? 'bold' : 'normal' }}
    >
      {children}
    </Link>
  )
}
app/blog/layout.tsx
// Import the Client Component into a parent Layout (Server Component)
import { BlogNavLink } from './blog-nav-link'
import getFeaturedPosts from './get-featured-posts'
 
export default async function Layout({
  children,
}: {
  children: React.ReactNode
}) {
  const featuredPosts = await getFeaturedPosts()
  return (
    <div>
      {featuredPosts.map((post) => (
        <div key={post.id}>
          <BlogNavLink slug={post.slug}>{post.title}</BlogNavLink>
        </div>
      ))}
      <div>{children}</div>
    </div>
  )
}

版本历史

版本变更
v13.0.0引入了 useSelectedLayoutSegment。