跳到内容

自定义应用

Next.js 使用 App 组件来初始化页面。你可以重写它并控制页面初始化和

  • 在页面切换之间创建共享布局
  • 向页面注入额外数据
  • 添加全局 CSS

用法

要重写默认的 App,请按如下所示创建文件 pages/_app

pages/_app.tsx
import type { AppProps } from 'next/app'
 
export default function MyApp({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />
}

Component prop 是当前活跃的 page,因此每当你导航到不同路由时,Component 将会变为新的 page。因此,你发送给 Component 的任何 prop 都将被 page 接收。

pageProps 是一个对象,其中包含通过我们的一种数据获取方法为你的页面预加载的初始 prop,否则它是一个空对象。

须知:

  • 如果你的应用程序正在运行并且你添加了一个自定义 App,你需要重启开发服务器。仅当 pages/_app.js 之前不存在时才需要。
  • App 不支持 Next.js 数据获取方法,例如 getStaticPropsgetServerSideProps

App 中的 getInitialProps

App 中使用 getInitialProps 将会禁用没有 getStaticProps 的页面的自动静态优化

我们不建议使用这种模式。 相反,请考虑逐步采用 App Router,它允许你更轻松地为页面和布局获取数据。

pages/_app.tsx
import App, { AppContext, AppInitialProps, AppProps } from 'next/app'
 
type AppOwnProps = { example: string }
 
export default function MyApp({
  Component,
  pageProps,
  example,
}: AppProps & AppOwnProps) {
  return (
    <>
      <p>Data: {example}</p>
      <Component {...pageProps} />
    </>
  )
}
 
MyApp.getInitialProps = async (
  context: AppContext
): Promise<AppOwnProps & AppInitialProps> => {
  const ctx = await App.getInitialProps(context)
 
  return { ...ctx, example: 'data' }
}