メインコンテンツまでスキップ

Link

<Link> は、HTML の <a> 要素を拡張して、プリフェッチとクライアントサイドのルート間ナビゲーションを提供する React コンポーネントです。Next.js でルート間をナビゲートする主な方法です。

基本的な使用法：

app/page.tsx
import Link from 'next/link'

export default function Page() {
  return <Link href="/dashboard">Dashboard</Link>
}

リファレンス​

以下の props を <Link> コンポーネントに渡すことができます：

PropExampleTypeRequired
hrefhref="/dashboard"String or ObjectYes
replacereplace={false}Boolean-
scrollscroll={false}Boolean-
prefetchprefetch={false}Boolean or null-

Good to know: <a> タグの属性（className や target="_blank" など）は、props として <Link> に追加でき、基になる <a> 要素に渡されます。

href（必須）​

ナビゲートするパスまたは URL。

app/page.tsx
import Link from 'next/link'

// /about?name=test にナビゲート
export default function Page() {
  return (
    <Link
      href={{
        pathname: '/about',
        query: { name: 'test' },
      }}
    >
      About
    </Link>
  )
}

replace​

デフォルトは false です。 true の場合、next/link は現在の履歴状態を置き換え、ブラウザの履歴スタックに新しい URL を追加しません。

app/page.tsx
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" replace>
      Dashboard
    </Link>
  )
}

scroll​

デフォルトは true です。 Next.js の <Link> のデフォルトのスクロール動作は、ブラウザが戻るや進むナビゲーションを処理する方法と同様に、スクロール位置を維持することです。新しいページにナビゲートすると、ページがビューポートに表示されている限り、スクロール位置は同じままです。ただし、ページがビューポートに表示されていない場合、Next.js は最初のページ要素の上部にスクロールします。

scroll = {false} の場合、Next.js は最初のページ要素にスクロールしようとしません。

Good to know: Next.js はスクロール動作を管理する前に scroll: false を確認します。スクロールが有効な場合、ナビゲーションの関連する DOM ノードを特定し、各トップレベル要素を検査します。すべてのスクロール不可能な要素やレンダリングされた HTML がない要素はバイパスされます。これには、固定位置の要素や、getBoundingClientRect で計算された非表示の要素が含まれます。Next.js は、ビューポート内で表示可能なスクロール可能な要素を特定するまで、兄弟要素を通過し続けます。

app/page.tsx
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" scroll={false}>
      Dashboard
    </Link>
  )
}

prefetch​

プリフェッチは、<Link /> コンポーネントがユーザーのビューポートに入るとき（初期またはスクロールによって）に発生します。Next.js はリンクされたルート（href で示される）とそのデータをバックグラウンドでプリフェッチしてロードし、クライアントサイドのナビゲーションのパフォーマンスを向上させます。プリフェッチされたデータがユーザーが <Link /> にホバーするまでに期限切れになっている場合、Next.js は再度プリフェッチを試みます。プリフェッチは本番環境でのみ有効です。

prefetch prop に渡すことができる値は次のとおりです：

  • null（デフォルト）: プリフェッチ動作はルートが静的か動的かによって異なります。静的ルートの場合、完全なルートがプリフェッチされます（すべてのデータを含む）。動的ルートの場合、loading.js 境界を持つ最も近いセグメントまでの部分ルートがプリフェッチされます。
  • true: 静的および動的ルートの両方で完全なルートがプリフェッチされます。
  • false: ビューポートに入るときもホバー時もプリフェッチは行われません。
app/page.tsx
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/dashboard" prefetch={false}>
      Dashboard
    </Link>
  )
}

例​

以下の例は、さまざまなシナリオで <Link> コンポーネントを使用する方法を示しています。

動的セグメントへのリンク​

動的セグメントにリンクする場合、テンプレートリテラルと補間を使用してリンクのリストを生成できます。たとえば、ブログ投稿のリストを生成するには：

app/blog/post-list.tsx
import Link from 'next/link'

interface Post {
  id: number
  title: string
  slug: string
}

export default function PostList({ posts }: { posts: Post[] }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${post.slug}`}>{post.title}</Link>
        </li>
      ))}
    </ul>
  )
}

usePathname() を使用して、リンクがアクティブかどうかを判断できます。たとえば、アクティブなリンクにクラスを追加するには、現在の pathname がリンクの href と一致するかどうかを確認します：

app/ui/nav-links.tsx
'use client'

import { usePathname } from 'next/navigation'
import Link from 'next/link'

export function Links() {
  const pathname = usePathname()

  return (
    <nav>
      <Link className={`link ${pathname === '/' ? 'active' : ''}`} href="/">
        Home
      </Link>

      <Link
        className={`link ${pathname === '/about' ? 'active' : ''}`}
        href="/about"
      >
        About
      </Link>
    </nav>
  )
}

id へのスクロール​

ナビゲーション時に特定の id にスクロールしたい場合、URL に # ハッシュリンクを追加するか、href prop にハッシュリンクを渡すことができます。これは、<Link> が <a> 要素にレンダリングされるため可能です。

<Link href="/dashboard#settings">Settings</Link>

// 出力
<a href="/dashboard#settings">Settings</a>

Good to know:

  • ナビゲーション時にページがビューポートに表示されていない場合、Next.js はページにスクロールします。

動的ルートセグメントへのリンク​

動的ルートセグメントの場合、テンプレートリテラルを使用してリンクのパスを作成するのが便利です。

たとえば、動的ルート app/blog/[slug]/page.js へのリンクのリストを生成できます：

app/blog/page.tsx
import Link from 'next/link'

export default function Page({ posts }) {
  return (
    <ul>
      {posts.map((post) => (
        <li key={post.id}>
          <Link href={`/blog/${post.slug}`}>{post.title}</Link>
        </li>
      ))}
    </ul>
  )
}

子が <a> タグをラップするカスタムコンポーネントの場合​

Link の子が <a> タグをラップするカスタムコンポーネントである場合、Link に passHref を追加する必要があります。これは、styled-components のようなライブラリを使用している場合に必要です。これがないと、<a> タグに href 属性がなくなり、サイトのアクセシビリティが損なわれ、SEO に影響を与える可能性があります。ESLint を使用している場合、passHref の正しい使用を保証するための組み込みルール next/link-passhref があります。

components/nav-link.tsx
import Link from 'next/link'
import styled from 'styled-components'

// これは <a> タグをラップするカスタムコンポーネントを作成します
const RedLink = styled.a`
  color: red;
`

function NavLink({ href, name }) {
  return (
    <Link href={href} passHref legacyBehavior>
      <RedLink>{name}</RedLink>
    </Link>
  )
}

export default NavLink
  • emotion の JSX プラグマ機能（@jsx jsx）を使用している場合、直接 <a> タグを使用していても passHref を使用する必要があります。
  • コンポーネントは onClick プロパティをサポートして、ナビゲーションを正しくトリガーする必要があります。

関数コンポーネントをネストする​

Link の子が関数コンポーネントである場合、passHref と legacyBehavior を使用することに加えて、コンポーネントを React.forwardRef でラップする必要があります：

app/page.tsx
import Link from 'next/link'
import React from 'react'

// MyButton の props タイプを定義
interface MyButtonProps {
  onClick?: React.MouseEventHandler<HTMLAnchorElement>
  href?: string
}

// React.ForwardRefRenderFunction を使用して転送された ref を適切に型付け
const MyButton: React.ForwardRefRenderFunction<
  HTMLAnchorElement,
  MyButtonProps
> = ({ onClick, href }, ref) => {
  return (
    <a href={href} onClick={onClick} ref={ref}>
      Click Me
    </a>
  )
}

// React.forwardRef を使用してコンポーネントをラップ
const ForwardedMyButton = React.forwardRef(MyButton)

export default function Page() {
  return (
    <Link href="/about" passHref legacyBehavior>
      <ForwardedMyButton />
    </Link>
  )
}

URL をプッシュする代わりに置き換える​

Link コンポーネントのデフォルトの動作は、history スタックに新しい URL を push することです。新しいエントリを追加しないようにするには、次の例のように replace prop を使用します：

app/page.js
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/about" replace>
      About us
    </Link>
  )
}

ページの上部へのスクロールを無効にする​

Next.js の <Link> のデフォルトのスクロール動作は、ブラウザが戻るや進むナビゲーションを処理する方法と同様に、スクロール位置を維持することです。新しいページにナビゲートすると、ページがビューポートに表示されている限り、スクロール位置は同じままです。

ただし、ページがビューポートに表示されていない場合、Next.js は最初のページ要素の上部にスクロールします。この動作を無効にしたい場合は、<Link> コンポーネントに scroll={false} を渡すか、router.push() または router.replace() に scroll: false を渡すことができます。

app/page.js
import Link from 'next/link'

export default function Page() {
  return (
    <Link href="/#hashid" scroll={false}>
      Disables scrolling to the top
    </Link>
  )
}

router.push() または router.replace() を使用する：

// useRouter
import { useRouter } from 'next/navigation'

const router = useRouter()

router.push('/dashboard', { scroll: false })

ミドルウェアを使用して、認証やユーザーを別のページにリダイレクトするなどの目的で使用することが一般的です。ミドルウェアを介してリライトされたリンクを <Link /> コンポーネントが適切にプリフェッチするためには、Next.js に表示する URL とプリフェッチする URL の両方を伝える必要があります。これは、プリフェッチする正しいルートを知るためにミドルウェアへの不要なフェッチを避けるために必要です。

たとえば、認証済みビューと訪問者ビューを持つ /dashboard ルートを提供したい場合、ミドルウェアでユーザーを正しいページにリダイレクトするために次のコードを追加できます：

middleware.ts
import { NextResponse } from 'next/server'

export function middleware(request: Request) {
  const nextUrl = request.nextUrl
  if (nextUrl.pathname === '/dashboard') {
    if (request.cookies.authToken) {
      return NextResponse.rewrite(new URL('/auth/dashboard', request.url))
    } else {
      return NextResponse.rewrite(new URL('/public/dashboard', request.url))
    }
  }
}

この場合、<Link /> コンポーネントで次のコードを使用することをお勧めします：

app/page.tsx
'use client'

import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed' // 認証フック

export default function Page() {
  const isAuthed = useIsAuthed()
  const path = isAuthed ? '/auth/dashboard' : '/public/dashboard'
  return (
    <Link as="/dashboard" href={path}>
      Dashboard
    </Link>
  )
}

バージョン履歴​

VersionChanges
v13.0.0子 <a> タグが不要になりました。コードモッド が提供されており、コードベースを自動的に更新できます。
v10.0.0動的ルートを指す href props は自動的に解決され、as prop を必要としなくなりました。
v8.0.0プリフェッチのパフォーマンスが向上しました。
v1.0.0next/link が導入されました。