| --- |
| title: page.js |
| description: API reference for the page.js file. |
| --- |
|
|
| The `page` file allows you to define UI that is **unique** to a route. You can create a page by default exporting a component from the file: |
|
|
| ```tsx filename="app/blog/[slug]/page.tsx" switcher |
| export default function Page({ |
| params, |
| searchParams, |
| }: { |
| params: Promise<{ slug: string }> |
| searchParams: Promise<{ [key: string]: string | string[] | undefined }> |
| }) { |
| return <h1>My Page</h1> |
| } |
| ``` |
|
|
| ```jsx filename="app/blog/[slug]/page.js" switcher |
| export default function Page({ params, searchParams }) { |
| return <h1>My Page</h1> |
| } |
| ``` |
|
|
| |
|
|
| - The `.js`, `.jsx`, or `.tsx` file extensions can be used for `page`. |
| - A `page` is always the **leaf** of the route subtree. |
| - A `page` file is required to make a route segment **publicly accessible**. |
| - Pages are [Server Components](https://react.dev/reference/rsc/server-components) by default, but can be set to a [Client Component](https://react.dev/reference/rsc/use-client). |
|
|
| |
|
|
| |
| |
| |
|
|
| A promise that resolves to an object containing the [dynamic route parameters](/docs/app/api-reference/file-conventions/dynamic-routes) from the root segment down to that page. |
|
|
| ```tsx filename="app/shop/[slug]/page.tsx" switcher |
| export default async function Page({ |
| params, |
| }: { |
| params: Promise<{ slug: string }> |
| }) { |
| const { slug } = await params |
| } |
| ``` |
|
|
| ```jsx filename="app/shop/[slug]/page.js" switcher |
| export default async function Page({ params }) { |
| const { slug } = await params |
| } |
| ``` |
|
|
| | Example Route | 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'] }>` | |
|
|
| - Since the `params` prop is a promise, you must use `async/await` or React's [`use`](https://react.dev/reference/react/use) function to access the values. |
| - In version 14 and earlier, `params` was a synchronous prop. To help with backwards compatibility, you can still access it synchronously in Next.js 15, but this behavior will be deprecated in the future. |
| |
| #### `searchParams` (optional) |
| |
| A promise that resolves to an object containing the [search parameters](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL#parameters) of the current URL. For example: |
| |
| ```tsx filename="app/shop/page.tsx" switcher |
| export default async function Page({ |
| searchParams, |
| }: { |
| searchParams: Promise<{ [key: string]: string | string[] | undefined }> |
| }) { |
| const filters = (await searchParams).filters |
| } |
| ``` |
| |
| ```jsx filename="app/shop/page.js" switcher |
| export default async function Page({ searchParams }) { |
| const filters = (await searchParams).filters |
| } |
| ``` |
| |
| Client Component **pages** can also access `searchParams` using React’s [`use`](https://react.dev/reference/react/use) hook: |
| |
| ```tsx filename="app/shop/page.tsx" switcher |
| 'use client' |
| import { use } from 'react' |
| |
| export default function Page({ |
| searchParams, |
| }: { |
| searchParams: Promise<{ [key: string]: string | string[] | undefined }> |
| }) { |
| const filters = use(searchParams).filters |
| } |
| ``` |
| |
| ```jsx filename="app/page.jsx" switcher |
| 'use client' |
| import { use } from 'react' |
| |
| export default function Page({ searchParams }) { |
| const filters = use(searchParams).filters |
| } |
| ``` |
| |
| | Example 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'] }>` | |
| |
| - Since the `searchParams` prop is a promise. You must use `async/await` or React's [`use`](https://react.dev/reference/react/use) function to access the values. |
| - In version 14 and earlier, `searchParams` was a synchronous prop. To help with backwards compatibility, you can still access it synchronously in Next.js 15, but this behavior will be deprecated in the future. |
| - `searchParams` is a **[Dynamic API](/docs/app/getting-started/partial-prerendering |
| - `searchParams` is a plain JavaScript object, not a `URLSearchParams` instance. |
|
|
| |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| Handling filtering with `searchParams` |
|
|
| You can use the `searchParams` prop to handle filtering, pagination, or sorting based on the query string of the URL. |
|
|
| ```tsx filename="app/shop/page.tsx" switcher |
| 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> |
| ) |
| } |
| ``` |
|
|
| ```jsx filename="app/shop/page.js" switcher |
| export default async function Page({ searchParams }) { |
| 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> |
| ) |
| } |
| ``` |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
