From a3e18daa1cfa5aa5799154eb0aa57b5936573df4 Mon Sep 17 00:00:00 2001 From: Lee Robinson Date: Sat, 12 Feb 2022 14:17:48 -0700 Subject: [PATCH] Update Preview Mode docs. (#34278) Follow up to https://github.com/vercel/next.js/pull/34142/files. --- docs/advanced-features/preview-mode.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/advanced-features/preview-mode.md b/docs/advanced-features/preview-mode.md index 8ef9c7a9fe1dc..7850663d5506b 100644 --- a/docs/advanced-features/preview-mode.md +++ b/docs/advanced-features/preview-mode.md @@ -171,24 +171,23 @@ https:///api/preview?secret=&slug= ## More Details -### Clear the preview mode cookies +### Clear the Preview Mode cookies -By default, no expiration date is set for the preview mode cookies, so the preview mode ends when the browser is closed. +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 cookies manually, you can create an API route which calls `clearPreviewData` and then access this API route. +To clear the Preview Mode cookies manually, create an API route that calls `clearPreviewData()`: ```js +// pages/api/clear-preview-mode-cookies.js + export default function handler(req, res) { - // Clears the preview mode cookies. - // This function accepts no arguments. res.clearPreviewData() - // ... } ``` -> **Note:** If calling this route using `Link` component, you must pass in `prefetch={false}` to prevent calling `clearPreviewData` during prefetch. +Then, send a request to `/api/clear-preview-mode-cookies` to invoke the API Route. If calling this route using [`next/link`](/docs/api-reference/next/link.md), you must pass `prefetch={false}` to prevent calling `clearPreviewData` during link prefetching. -### Specify the preview mode duration +### Specify the Preview Mode duration `setPreviewData` takes an optional second parameter which should be an options object. It accepts the following keys: