usePreviewMode

预览模式允许你在不向用户公开的情况下查看更改在实时站点上的显示效果。

你可以使用内置的 usePreviewMode 可组合函数来访问和控制 Nuxt 中的预览状态。如果该可组合函数检测到预览模式，它将自动强制执行必要的更新，以使 useAsyncData 和 useFetch 重新渲染预览内容。

const { enabled, state } = usePreviewMode()

选项

自定义 enable 检查

你可以指定自定义的方式来启用预览模式。默认情况下，如果 URL 中有一个 preview 参数且值为 true（例如，http://localhost:3000?preview=true），usePreviewMode 可组合函数将启用预览模式。你可以将 usePreviewMode 包装到自定义可组合函数中，以保持选项在多次使用中的一致性并防止任何错误。

export function useMyPreviewMode () {
  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