usePreviewMode

预览模式允许你查看更改在在线站点上如何显示，而不会向用户公开这些更改。

你可以使用内置的 usePreviewMode 组合式函数，在 Nuxt 中访问和控制预览状态。如果该组合式函数检测到预览模式，就会自动强制执行 useAsyncData 和 useFetch 所需的任何更新，以重新渲染预览内容。

const { enabled, state } = usePreviewMode()

选项

自定义 enable 检查

你可以指定自定义的方式来启用预览模式。默认情况下，如果 URL 中存在且等于 true 的 preview 参数（例如，http://localhost:3000?preview=true），usePreviewMode 组合式函数会启用预览模式。你可以将 usePreviewMode 封装成自定义组合式函数，以保持使用中的选项一致，避免任何错误。

export function useMyPreviewMode () {
  const route = useRoute()
  return usePreviewMode({
    shouldEnable: () => {
      return !!route.query.customPreview
    },
  })
}

修改默认状态

usePreviewMode 会尝试将 URL 中 token 参数的值存储在状态中。你可以修改此状态，它将适用于所有 usePreviewMode 调用。

const data1 = ref('data1')

const { enabled, state } = usePreviewMode({
  getState: (currentState) => {
    return { data1, data2: 'data2' }
  },
})

自定义 onEnable 和 onDisable 回调

默认情况下，当启用 usePreviewMode 时，它会调用 refreshNuxtData() 来重新从服务器获取所有数据。

当禁用预览模式时，该组合式函数会附加一个回调，在随后的路由导航后调用 refreshNuxtData()。

你可以通过为 onEnable 和 onDisable 选项提供自定义函数，指定自定义回调。

const { enabled, state } = usePreviewMode({
  onEnable: () => {
    console.log('预览模式已启用')
  },
  onDisable: () => {
    console.log('预览模式已禁用')
  },
})

示例

下面的示例创建了一个页面，其中部分内容仅在预览模式下渲染。

<script setup>
const { enabled, state } = usePreviewMode()

const { data } = await useFetch('/api/preview', {
  query: {
    apiKey: state.token,
  },
})
</script>

<template>
  <div>
    一些基础内容
    <p v-if="enabled">
      仅预览内容：{{ state.token }}
      <br>
      <button @click="enabled = false">
        禁用预览模式
      </button>
    </p>
  </div>
</template>

现在你可以生成站点并进行服务：

npx nuxt generate
npx nuxt preview

然后，你可以通过在要查看的页面末尾添加查询参数 preview 来访问预览页面：

?preview=true