Preview Mode

This document is for Next.js versions 9.3 and up. If you’re using older versions of Next.js, refer to our previous documentation.

Examples

In the Pages documentation and the Data Fetching documentation, we talked about how to pre-render a page at build time (Static Generation) using getStaticProps and getStaticPaths.

Static Generation is useful when your pages fetch data from a headless CMS. However, it’s not ideal when you’re writing a draft on your headless CMS and want to preview the draft immediately on your page. You’d want Next.js to render these pages at request time instead of build time and fetch the draft content instead of the published content. You’d want Next.js to bypass Static Generation only for this specific case.

Next.js has a feature called Preview Mode which solves this problem. Here are instructions on how to use it.

Step 1. Create and access a preview API route

Take a look at the API Routes documentation first if you’re not familiar with Next.js API Routes.

First, create a preview API route. It can have any name - e.g. pages/api/preview.js (or .ts if using TypeScript).

In this API route, you need to call setPreviewData on the response object. The argument for setPreviewData should be an object, and this can be used by getStaticProps (more on this later). For now, we’ll use {}.

  1. export default function handler(req, res) {
  2.   // ...
  3.   res.setPreviewData({})
  4.   // ...
  5. }

res.setPreviewData sets some cookies on the browser which turns on the preview mode. Any requests to Next.js containing these cookies will be considered as the preview mode, and the behavior for statically generated pages will change (more on this later).

You can test this manually by creating an API route like below and accessing it from your browser manually:

  1. // A simple example for testing it manually from your browser.
  2. // If this is located at pages/api/preview.js, then
  3. // open /api/preview from your browser.
  4. export default function handler(req, res) {
  5.   res.setPreviewData({})
  6.   res.end('Preview mode enabled')
  7. }

If you use your browser’s developer tools, you’ll notice that the __prerender_bypass and __next_preview_data cookies will be set on this request.

Securely accessing it from your Headless CMS

In practice, you’d want to call this API route securely from your headless CMS. The specific steps will vary depending on which headless CMS you’re using, but here are some common steps you could take.

These steps assume that the headless CMS you’re using supports setting custom preview URLs. If it doesn’t, you can still use this method to secure your preview URLs, but you’ll need to construct and access the preview URL manually.

First, you should create a secret token string using a token generator of your choice. This secret will only be known by your Next.js app and your headless CMS. This secret prevents people who don’t have access to your CMS from accessing preview URLs.

Second, if your headless CMS supports setting custom preview URLs, specify the following as the preview URL. (This assumes that your preview API route is located at pages/api/preview.js.)

  1. https://<your-site>/api/preview?secret=<token>&slug=<path>
  • <your-site> should be your deployment domain.
  • <token> should be replaced with the secret token you generated.
  • <path> should be the path for the page that you want to preview. If you want to preview /posts/foo, then you should use &slug=/posts/foo.

Your headless CMS might allow you to include a variable in the preview URL so that <path> can be set dynamically based on the CMS’s data like so: &slug=/posts/{entry.fields.slug}

Finally, in the preview API route:

  • Check that the secret matches and that the slug parameter exists (if not, the request should fail).

  • Call res.setPreviewData.

  • Then redirect the browser to the path specified by slug. (The following example uses a 307 redirect).
  1. export default async (req, res) => {
  2.   // Check the secret and next parameters
  3.   // This secret should only be known to this API route and the CMS
  4.   if (req.query.secret !== 'MY_SECRET_TOKEN' || !req.query.slug) {
  5.     return res.status(401).json({ message: 'Invalid token' })
  6.   }
  8.   // Fetch the headless CMS to check if the provided `slug` exists
  9.   // getPostBySlug would implement the required fetching logic to the headless CMS
  10.   const post = await getPostBySlug(req.query.slug)
  12.   // If the slug doesn't exist prevent preview mode from being enabled
  13.   if (!post) {
  14.     return res.status(401).json({ message: 'Invalid slug' })
  15.   }
  17.   // Enable Preview Mode by setting the cookies
  18.   res.setPreviewData({})
  20.   // Redirect to the path from the fetched post
  21.   // We don't redirect to req.query.slug as that might lead to open redirect vulnerabilities
  22.   res.redirect(post.slug)
  23. }

If it succeeds, then the browser will be redirected to the path you want to preview with the preview mode cookies being set.

Step 2. Update getStaticProps

The next step is to update getStaticProps to support the preview mode.

If you request a page which has getStaticProps with the preview mode cookies set (via res.setPreviewData), then getStaticProps will be called at request time (instead of at build time).

Furthermore, it will be called with a context object where:

  • context.preview will be true.
  • context.previewData will be the same as the argument used for setPreviewData.
  1. export async function getStaticProps(context) {
  2.   // If you request this page with the preview mode cookies set:
  3.   //
  4.   // - context.preview will be true
  5.   // - context.previewData will be the same as
  6.   //   the argument used for `setPreviewData`.
  7. }

We used res.setPreviewData({}) in the preview API route, so context.previewData will be {}. You can use this to pass session information from the preview API route to getStaticProps if necessary.

If you’re also using getStaticPaths, then context.params will also be available.

Fetch preview data

You can update getStaticProps to fetch different data based on context.preview and/or context.previewData.

For example, your headless CMS might have a different API endpoint for draft posts. If so, you can use context.preview to modify the API endpoint URL like below:

  1. export async function getStaticProps(context) {
  2.   // If context.preview is true, append "/preview" to the API endpoint
  3.   // to request draft data instead of published data. This will vary
  4.   // based on which headless CMS you're using.
  5.   const res = await fetch(`https://.../${context.preview ? 'preview' : ''}`)
  6.   // ...
  7. }

That’s it! If you access the preview API route (with secret and slug) from your headless CMS or manually, you should now be able to see the preview content. And if you update your draft without publishing, you should be able to preview the draft.

  1. # Set this as the preview URL on your headless CMS or access manually,
  2. # and you should be able to see the preview.
  3. https://<your-site>/api/preview?secret=<token>&slug=<path>

More Details

Note: during rendering next/router exposes an isPreview flag, see the router object docs for more info.

Clear the Preview Mode cookies

By default, no expiration date is set for Preview Mode cookies, so the preview session ends when the browser is closed.

To clear the Preview Mode cookies manually, create an API route that calls clearPreviewData():

  1. // pages/api/clear-preview-mode-cookies.js
  3. export default function handler(req, res) {
  4.   res.clearPreviewData()
  5. }

Then, send a request to /api/clear-preview-mode-cookies to invoke the API Route. If calling this route using next/link, you must pass prefetch={false} to prevent calling clearPreviewData during link prefetching.

Specify the Preview Mode duration

setPreviewData takes an optional second parameter which should be an options object. It accepts the following keys:

  • maxAge: Specifies the number (in seconds) for the preview session to last for.
  • path: Specifies the path the cookie should be applied under. Defaults to / enabling preview mode for all paths.
  1. setPreviewData(data, {
  2.   maxAge: 60 * 60, // The preview mode cookies expire in 1 hour
  3.   path: '/about', // The preview mode cookies apply to paths with /about
  4. })

previewData size limits

You can pass an object to setPreviewData and have it be available in getStaticProps. However, because the data will be stored in a cookie, there’s a size limitation. Currently, preview data is limited to 2KB.

Works with getServerSideProps

The preview mode works on getServerSideProps as well. It will also be available on the context object containing preview and previewData.

Works with API Routes

API Routes will have access to preview and previewData under the request object. For example:

  1. export default function myApiRoute(req, res) {
  2.   const isPreview = req.preview
  3.   const previewData = req.previewData
  4.   // ...
  5. }

Unique per next build

Both the bypass cookie value and the private key for encrypting the previewData change when next build is completed. This ensures that the bypass cookie can’t be guessed.

Note: To test Preview Mode locally over HTTP your browser will need to allow third-party cookies and local storage access.

Learn more

The following pages might also be useful.

Data FetchingLearn more about data fetching in Next.js.

API RoutesLearn more about API routes in Next.js.

Environment VariablesLearn more about environment variables in Next.js.