Static Generation can be done with and without data.
So far, all the pages we’ve created do not require fetching external data. Those pages will automatically be statically generated when the app is built for production.
However, for some pages, you might not be able to render the HTML without first fetching some external data. Maybe you need to access the file system, fetch external API, or query your database at build time. Next.js supports this case — Static Generation with data — out of the box.
getStaticProps
How does it work? Well, in Next.js, when you export a page component, you can also export an async
function called getStaticProps
. If you do this, then:
getStaticProps
runs at build time in production, and…export default function Home(props) { ... }
export async function getStaticProps() {
// Get external data from the file system, API, DB, etc.
const data = ...
// The value of the `props` key will be
// passed to the `Home` component
return {
props: ...
}
}
Essentially, getStaticProps
allows you to tell Next.js: "Hey, this page has some data dependencies — so when you pre-render this page at build time, make sure to resolve them first!"
Note: In development mode,
getStaticProps
runs on each request instead.
getStaticProps
It’s easier to learn by doing, so starting from the next page, we’ll use getStaticProps
to implement our blog.