NNext.js 中文网 GitHub

页面和布局

使用 Pages Router 创建你的第一个页面和共享布局。

Pages Router 有一个基于文件系统的路由器,它建立在页面的概念之上。

当文件被添加到 pages 目录时,它会自动作为一条路由可用。

在 Next.js 中,页面是从 pages 目录中的 .js、.jsx、.ts 或 .tsx 文件导出的 React 组件。每个页面根据其文件名与一条路由相关联。

示例:如果你创建如下导出 React 组件的 pages/about.js 文件,它将可以通过 /about 访问。

jsx
export default function About() {
  return <div>About</div>
}

索引路由#

路由器会自动将名为 index 的文件路由到目录的根路径。

  • pages/index.js → /
  • pages/blog/index.js → /blog

嵌套路由#

路由器支持嵌套文件。如果你创建嵌套的文件夹结构,文件仍会以相同的方式自动路由。

  • pages/blog/first-post.js → /blog/first-post
  • pages/dashboard/settings/username.js → /dashboard/settings/username

使用动态路由的页面#

Next.js 支持使用动态路由的页面。例如,如果你创建一个名为 pages/posts/[id].js 的文件,那么它将可以通过 posts/1、posts/2 等路径访问。

要了解有关动态路由的更多信息,请查看动态路由文档。

布局模式#

React 模型允许我们将页面拆解为一系列组件。其中许多组件经常在页面之间复用。例如,每个页面可能都有相同的导航栏和页脚。

components/layout.js
import Navbar from './navbar'
import Footer from './footer'

export default function Layout({ children }) {
  return (
    <>
      <Navbar />
      <main>{children}</main>
      <Footer />
    </>
  )
}

示例#

使用自定义 App 实现单一共享布局#

如果你整个应用程序只有一个布局,可以创建一个自定义 App,并用该布局包裹你的应用程序。由于切换页面时 <Layout /> 组件会被复用,其组件状态将被保留(例如输入值)。

pages/_app.js
import Layout from '../components/layout'

export default function MyApp({ Component, pageProps }) {
  return (
    <Layout>
      <Component {...pageProps} />
    </Layout>
  )
}

每页布局#

如果你需要多个布局,可以向页面添加 getLayout 属性,使其返回一个用于布局的 React 组件。这使你可以按页面定义布局。由于我们返回的是一个函数,因此可以根据需要实现复杂的嵌套布局。

pages/index.js

import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'

export default function Page() {
  return (
    /** 你的内容 */
  )
}

Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}
pages/_app.js
export default function MyApp({ Component, pageProps }) {
  // 如果可用,使用在页面级别定义的布局
  const getLayout = Component.getLayout ?? ((page) => page)

  return getLayout(<Component {...pageProps} />)
}

在页面之间导航时,我们希望保留页面状态(输入值、滚动位置等),以获得单页应用(SPA)体验。

这种布局模式能够实现状态保留,因为在页面切换之间 React 组件树得以维持。借助组件树,React 可以了解哪些元素发生了变化,从而保留状态。

小知识:这个过程称为协调,React 通过它来了解哪些元素发生了变化。

使用 TypeScript#

使用 TypeScript 时,你必须首先为页面创建一个新类型,其中包含 getLayout 函数。然后,你必须为 AppProps 创建一个新类型,它重写 Component 属性以使用之前创建的类型。

pages/index.tsx
import type { ReactElement } from 'react'
import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'
import type { NextPageWithLayout } from './_app'

const Page: NextPageWithLayout = () => {
  return <p>hello world</p>
}

Page.getLayout = function getLayout(page: ReactElement) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

export default Page
pages/index.js
import Layout from '../components/layout'
import NestedLayout from '../components/nested-layout'

const Page = () => {
  return <p>hello world</p>
}

Page.getLayout = function getLayout(page) {
  return (
    <Layout>
      <NestedLayout>{page}</NestedLayout>
    </Layout>
  )
}

export default Page
pages/_app.tsx
import type { ReactElement, ReactNode } from 'react'
import type { NextPage } from 'next'
import type { AppProps } from 'next/app'

export type NextPageWithLayout<P = {}, IP = P> = NextPage<P, IP> & {
  getLayout?: (page: ReactElement) => ReactNode
}

type AppPropsWithLayout = AppProps & {
  Component: NextPageWithLayout
}

export default function MyApp({ Component, pageProps }: AppPropsWithLayout) {
  // 如果可用,使用在页面级别定义的布局
  const getLayout = Component.getLayout ?? ((page) => page)

  return getLayout(<Component {...pageProps} />)
}
pages/_app.js
export default function MyApp({ Component, pageProps }) {
  // 如果可用,使用在页面级别定义的布局
  const getLayout = Component.getLayout ?? ((page) => page)

  return getLayout(<Component {...pageProps} />)
}

数据获取#

在布局内部,你可以使用 useEffect 或类似 SWR 的库在客户端获取数据。由于此文件不是页面,目前不能使用 getStaticProps 或 getServerSideProps。

components/layout.js
import useSWR from 'swr'
import Navbar from './navbar'
import Footer from './footer'

export default function Layout({ children }) {
  const { data, error } = useSWR('/api/navigation', fetcher)

  if (error) return <div>Failed to load</div>
  if (!data) return <div>Loading...</div>

  return (
    <>
      <Navbar links={data.links} />
      <main>{children}</main>
      <Footer />
    </>
  )
}
Next.js 中文网