Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix issues in getStaticPaths docs #34840

Merged
merged 2 commits into from Feb 26, 2022
Merged

Fix issues in getStaticPaths docs #34840

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ef070a
Fix issues in getStaticPaths docs
ijjk Feb 26, 2022
6836986
Merge branch 'canary' into docs/get-static-paths
kodiakhq[bot] Feb 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/basic-features/data-fetching/get-static-paths.md
View file
Open in desktop
Expand Up @@ -35,15 +35,15 @@ You should use `getStaticPaths` if you’re statically pre-rendering pages that

## When does getStaticPaths run

`getStaticPaths` always runs on the server and never on the client. You can validate code written inside `getStaticPaths` is removed from the client-side bundle [with this tool](https://next-code-elimination.vercel.app/).
`getStaticPaths` will only run during build in production, it will not be called during runtime. You can validate code written inside `getStaticPaths` is removed from the client-side bundle [with this tool](https://next-code-elimination.vercel.app/).

- `getStaticPaths` runs during `next build` for Pages included in `paths`
- `getStaticPaths` runs on-demand in the background when using `fallback: true`
- `getStaticPaths` runs on-demand blocking rendering when using `fallback: blocking`
- `getStaticProps` runs during `next build` for any `paths` returned during build
- `getStaticProps` runs in the background when using `fallback: true`
- `getStaticProps` is called before initial render when using `fallback: blocking`

## Where can I use getStaticPaths

`getStaticPaths` can only be exported from a **page**. You **cannot** export it from non-page files.
`getStaticPaths` can only be exported from a [dynamic route](/docs/routing/dynamic-routes.md) that also uses `getStaticProps`. You **cannot** export it from non-page files e.g. from your `components` folder.

Note that you must use export `getStaticPaths` as a standalone function — it will **not** work if you add `getStaticPaths` as a property of the page component.

Expand Down