usePreviewMode

プレビューモードを使用すると、変更がライブサイトでどのように表示されるかを確認できます。

組み込みのusePreviewModeコンポーザブルを使用して、Nuxtのプレビューステータスにアクセスし、制御できます。コンポーザブルがプレビューモードを検出すると、useAsyncDataおよびuseFetchがプレビューコンテンツを再レンダリングするために必要な更新を自動的に強制します。

const { enabled, state } = usePreviewMode()

オプション

カスタムenableチェック

プレビューモードを有効にするカスタム方法を指定できます。デフォルトでは、usePreviewModeコンポーザブルは、URLにpreviewパラメーターがあり、その値がtrue（例：https://:3000?preview=true）である場合にプレビューモードを有効にします。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('preview mode has been enabled')
  },
  onDisable: () => {
    console.log('preview mode has been disabled')
  },
})

例

以下の例では、コンテンツの一部がプレビューモードでのみレンダリングされるページを作成します。

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

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

<template>
  <div>
    Some base content
    <p v-if="enabled">
      Only preview content: {{ state.token }}
      <br>
      <button @click="enabled = false">
        disable preview mode
      </button>
    </p>
  </div>
</template>

これで、サイトを生成して提供できます。

npx nuxt generate
npx nuxt preview

その後、見たいページの最後にクエリパラメーターpreviewを追加することで、プレビューページを見ることができます。例えば、https://:3000/?preview=true。