draftMode

draftMode 是一个异步函数，它允许你在服务器组件中启用和禁用草稿模式，以及检查草稿模式是否已启用。

import { draftMode } from 'next/headers'
 
export default async function Page() {
  const { isEnabled } = await draftMode()
}

参考

以下方法和属性可用：

方法	描述
`isEnabled`	一个布尔值，指示草稿模式是否已启用。
`enable()`	通过设置 cookie (`__prerender_bypass`) 在路由处理程序中启用草稿模式。
`disable()`	通过删除 cookie 在路由处理程序中禁用草稿模式。

须知

draftMode 是一个异步函数，它返回一个 Promise。你必须使用 async/await 或 React 的 use 函数。
- 在版本 14 及更早版本中，draftMode 是一个同步函数。为了帮助向后兼容，你仍然可以在 Next.js 15 中同步访问它，但此行为将来会被弃用。
每次运行 next build 时都会生成一个新的旁路 cookie 值。这可确保旁路 cookie 无法被猜测。
要在本地通过 HTTP 测试草稿模式，你的浏览器需要允许第三方 cookie 和本地存储访问。

示例

启用草稿模式

要启用草稿模式，请创建一个新的路由处理程序并调用 enable() 方法

import { draftMode } from 'next/headers'
 
export async function GET(request: Request) {
  const draft = await draftMode()
  draft.enable()
  return new Response('Draft mode is enabled')
}

禁用草稿模式

默认情况下，草稿模式会话在浏览器关闭时结束。

要手动禁用草稿模式，请在你的路由处理程序中调用 disable() 方法

import { draftMode } from 'next/headers'
 
export async function GET(request: Request) {
  const draft = await draftMode()
  draft.disable()
  return new Response('Draft mode is disabled')
}

然后，发送请求来调用路由处理程序。如果使用<Link> 组件调用路由，你必须传入 prefetch={false} 以防止在预取时意外删除 cookie。

检查草稿模式是否已启用

你可以使用 isEnabled 属性检查服务器组件中是否启用了草稿模式

import { draftMode } from 'next/headers'
 
export default async function Page() {
  const { isEnabled } = await draftMode()
  return (
    <main>
      <h1>My Blog Post</h1>
      <p>Draft Mode is currently {isEnabled ? 'Enabled' : 'Disabled'}</p>
    </main>
  )
}

版本历史

版本	更改
`v15.0.0-RC`	`draftMode` 现在是一个异步函数。提供了一个代码转换器。
`v13.4.0`	引入了 `draftMode`。

下一步

通过此分步指南了解如何使用草稿模式。

草稿模式

Next.js 具有草稿模式，可在静态页面和动态页面之间切换。你可以在此处了解其与 App Router 的工作方式。