Menu

page.js

page 文件用于在你的 Next.js 应用中定义页面。

app/blog/[slug]/page.tsx
TypeScript
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，解析后返回一个包含从根段到该页面的动态路由参数的对象。

app/shop/[slug]/page.tsx
TypeScript
export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const slug = (await params).slug
}
示例路由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 属性是一个 promise，你必须使用 async/await 或 React 的 use 函数来访问其值。
    • 在版本 14 及更早版本中，params 是一个同步属性。为了向后兼容，你在 Next.js 15 中仍然可以同步访问它，但这个行为在未来会被弃用。

searchParams (可选)

一个 Promise，解析后返回一个包含当前 URL 的搜索参数的对象。例如：

app/shop/page.tsx
TypeScript
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 属性是一个 promise，你必须使用 async/await 或 React 的 use 函数来访问其值。
    • 在版本 14 及更早版本中，searchParams 是一个同步属性。为了向后兼容，你在 Next.js 15 中仍然可以同步访问它，但这个行为在未来会被弃用。
  • searchParams 是一个**动态 API，其值无法提前获知。使用它会使页面在请求时采用动态渲染**。
  • searchParams 是一个普通的 JavaScript 对象，而不是 URLSearchParams 实例。

示例

基于 params 显示内容

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

app/blog/[slug]/page.tsx
TypeScript
export default async function Page({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  return <h1>Blog Post: {slug}</h1>
}

使用 searchParams 处理筛选

你可以使用 searchParams 属性来处理基于 URL 查询字符串的筛选、分页或排序。

app/shop/page.tsx
TypeScript
export default async function Page({
  searchParams,
}: {
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const { page = '1', sort = 'asc', query = '' } = await searchParams
 
  return (
    <div>
      <h1>Product Listing</h1>
      <p>Search query: {query}</p>
      <p>Current page: {page}</p>
      <p>Sort order: {sort}</p>
    </div>
  )
}

在客户端组件中读取 searchParams 和 params

要在客户端组件（不能是 async）中使用 searchParams 和 params，你可以使用 React 的 use 函数来读取 promise：

app/page.tsx
TypeScript
'use client'
 
import { use } from 'react'
 
export function Page({
  params,
  searchParams,
}: {
  params: Promise<{ slug: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
  const { slug } = use(params)
  const { query } = use(searchParams)
}
app/page.js
'use client'
 
import { use } from 'react'
 
export function Page({ params, searchParams }) {
  const { slug } = use(params)
  const { query } = use(searchParams)
}

版本历史

版本变更
v15.0.0-RCparams 和 searchParams 现在是 promise。提供了一个代码转换工具。
v13.0.0引入 page。