NextJS中文文档 - Draft Mode

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

import { draftMode } from 'next/headers'

export default async function Page() {
  const { isEnabled } = await 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')
}

import { draftMode } from 'next/headers'

export async function GET(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')
}

import { draftMode } from 'next/headers'

export async function GET(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>
  )
}

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.RC	draftMode 现在是一个异步函数。提供了一个 codemod。
v13.4.0	引入 draftMode。