自定义 App
通过覆盖 Next.js 使用的默认 App 组件,控制页面初始化并添加对所有页面持续存在的布局。
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} />
}pages/_app.jsx
export default function MyApp({ Component, pageProps }) {
return <Component {...pageProps} />
}Component 属性是当前的 page,因此每当你在路由之间导航时,Component 都会变为新的 page。因此,你发送给 Component 的任何属性都会被 page 接收。
pageProps 是一个对象,包含由我们的某个数据获取方法为你的页面预加载的初始属性,否则它是一个空对象。
小知识:
- 如果你的应用正在运行且添加了自定义
App,则需要重启开发服务器。仅当pages/_app.js之前不存在时才需要这样做。App不支持 Next.js 的数据获取方法,例如getStaticProps或getServerSideProps。
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' }
}pages/_app.jsx
import App from 'next/app'
export default function MyApp({ Component, pageProps, example }) {
return (
<>
<p>Data: {example}</p>
<Component {...pageProps} />
</>
)
}
MyApp.getInitialProps = async (context) => {
const ctx = await App.getInitialProps(context)
return { ...ctx, example: 'data' }
}