Nuxt Nation カンファレンス開催!11月12日〜13日

useRouteAnnouncer

このコンポーザブルはページタイトルの変更を観察し、それに応じてアナウンサーメッセージを更新します。
このコンポーザブルはNuxt v3.12以降で使用できます。

説明

ページタイトルの変更を観察し、それに応じてアナウンサーメッセージを更新するコンポーザブルです。<NuxtRouteAnnouncer>によって使用され、制御可能です。Unheadのdom:renderedにフックして、ページのタイトルを読み取り、アナウンサーメッセージとして設定します。

パラメーター

  • politeness: スクリーンリーダーによるアナウンスの緊急度を設定します。 off(アナウンスを無効化)、polite(静寂を待ってからアナウンス)、またはassertive(すぐに割り込み)。(デフォルトはpolite)。

プロパティ

message

  • : Ref<string>
  • 説明: アナウンスするメッセージ

politeness

  • : Ref<string>
  • 説明: スクリーンリーダーのアナウンスの緊急度レベル offpolite、またはassertive

メソッド

set(message, politeness = "polite")

アナウンスするメッセージとその緊急度レベルを設定します。

polite(message)

politeness = "polite"でメッセージを設定します。

assertive(message)

politeness = "assertive"でメッセージを設定します。

pages/index.vue
<script setup lang="ts">
  const { message, politeness, set, polite, assertive } = useRouteAnnouncer({
    politeness: 'assertive'
  })
</script>