page.js
page
文件用于在您的 Next.js 应用程序中定义页面。
app/blog/[slug]/page.tsx
export default function Page({
params,
searchParams,
}: {
params: Promise<{ slug: string }>
searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
return <h1>My Page</h1>
}
参考
属性
params
(可选)
一个解析为包含从根段到该页面的动态路由参数的对象的 Promise。
app/shop/[slug]/page.tsx
export default async function Page({
params,
}: {
params: Promise<{ slug: string }>
}) {
const slug = (await params).slug
}
示例路由 | URL | params |
---|---|---|
app/shop/[slug]/page.js | /shop/1 | Promise<{ slug: '1' }> |
app/shop/[category]/[item]/page.js | /shop/1/2 | Promise<{ category: '1', item: '2' }> |
app/shop/[...slug]/page.js | /shop/1/2 | Promise<{ slug: ['1', '2'] }> |
- 由于
params
属性是一个 Promise,因此您必须使用async/await
或 React 的use
函数来访问这些值。- 在版本 14 及更早版本中,
params
是一个同步属性。为了帮助向后兼容,您仍然可以在 Next.js 15 中同步访问它,但此行为将在未来弃用。
- 在版本 14 及更早版本中,
searchParams
(可选)
一个解析为包含当前 URL 的搜索参数的对象的 Promise。例如
app/shop/page.tsx
export default async function Page({
searchParams,
}: {
searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}) {
const filters = (await searchParams).filters
}
示例 URL | searchParams |
---|---|
/shop?a=1 | Promise<{ a: '1' }> |
/shop?a=1&b=2 | Promise<{ a: '1', b: '2' }> |
/shop?a=1&a=2 | Promise<{ a: ['1', '2'] }> |
- 由于
searchParams
属性是一个 Promise,因此您必须使用async/await
或 React 的use
函数来访问这些值。- 在版本 14 及更早版本中,
searchParams
是一个同步属性。为了帮助向后兼容,您仍然可以在 Next.js 15 中同步访问它,但此行为将在未来弃用。
- 在版本 14 及更早版本中,
searchParams
是一个动态 API,其值无法提前知道。使用它将使页面在请求时启用动态渲染。searchParams
是一个普通的 JavaScript 对象,而不是URLSearchParams
实例。
## 示例
基于 params
显示内容
使用 动态路由段,您可以根据 params
属性显示或获取页面特定内容。
app/blog/[slug]/page.tsx
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
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
'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)
}
版本历史
版本 | 更改 |
---|---|
v15.0.0-RC | params 和 searchParams 现在是 Promise。提供了一个 codemod。 |
v13.0.0 | 引入了 page 。 |
这有帮助吗?