page.js

page 文件允许你为路由定义唯一的 UI。你可以通过默认导出一个组件来创建页面:

export default function Page({
  params,
  searchParams,
}: {
  params: Promise<{ slug: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  return <h1>My Page</h1>
}

须知

参考

Props

params (可选)

一个解析为包含从根段到该页面的动态路由参数对象的 Promise。

export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
}
示例路由URLparams
app/shop/[slug]/page.js/shop/1Promise<{ slug: '1' }>
app/shop/[category]/[item]/page.js/shop/1/2Promise<{ category: '1', item: '2' }>
app/shop/[...slug]/page.js/shop/1/2Promise<{ slug: ['1', '2'] }>
  • 由于 params prop 是一个 Promise,你必须使用 async/await 或 React 的 use 函数来访问其值。
    • 在版本 14 及更早版本中,params 是一个同步 prop。为了向后兼容,在 Next.js 15 中你仍然可以同步访问它,但这一行为将在未来被弃用。

searchParams (可选)

一个解析为包含当前 URL 查询参数对象的 Promise。例如:

export default async function Page({
  searchParams,
}: {
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const filters = (await searchParams).filters
}
示例 URLsearchParams
/shop?a=1Promise<{ a: '1' }>
/shop?a=1&b=2Promise<{ a: '1', b: '2' }>
/shop?a=1&a=2Promise<{ a: ['1', '2'] }>
  • 由于 searchParams prop 是一个 Promise,你必须使用 async/await 或 React 的 use 函数来访问其值。
    • 在版本 14 及更早版本中,searchParams 是一个同步 prop。为了向后兼容,在 Next.js 15 中你仍然可以同步访问它,但这一行为将在未来被弃用。
  • searchParams 是一个**动态 API,其值无法提前预知。使用它会将页面在请求时转为动态渲染 (dynamic rendering)**。
  • searchParams 是一个普通的 JavaScript 对象,不是 URLSearchParams 实例。

示例

基于 params 显示内容

使用动态路由段,你可以根据 params prop 显示或获取页面的特定内容。

export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  return <h1>博客文章: {slug}</h1>
}

使用 searchParams 处理筛选

你可以使用 searchParams prop 根据 URL 的查询字符串处理筛选、分页或排序。

export default async function Page({
  searchParams,
}: {
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const { page = '1', sort = 'asc', query = '' } = await searchParams

  return (
    <div>
      <h1>产品列表</h1>
      <p>搜索查询: {query}</p>
      <p>当前页数: {page}</p>
      <p>排序方式: {sort}</p>
    </div>
  )
}

在客户端组件中读取 searchParamsparams

要在客户端组件(不能是 async)中使用 searchParamsparams,你可以使用 React 的 use 函数来读取 Promise:

'use client'

import { use } from 'react'

export default function Page({
  params,
  searchParams,
}: {
  params: Promise<{ slug: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const { slug } = use(params)
  const { query } = use(searchParams)
}

版本历史

版本变更
v15.0.0-RCparamssearchParams 现在为 Promise。提供了代码迁移工具
v13.0.0引入 page

On this page