nuxt logo

ドキュメント翻訳(非公式)

useRouteAnnouncer

このコンポーザブルはページタイトルの変更を監視し、それに応じてアナウンサーメッセージを更新します。

このコンポーザブルは Nuxt v3.12+ で利用可能です。

説明

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

パラメータ

  • politeness: スクリーンリーダーのアナウンスの緊急度を設定します: off(アナウンスを無効にする)、polite(静寂を待つ)、または assertive(即座に中断する)。(デフォルトは polite)。

プロパティ

message

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

politeness

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

メソッド

set(message, politeness = "polite")

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

polite(message)

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

assertive(message)

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

pages/index.vue
const { message, politeness, set, polite, assertive } = useRouteAnnouncer({
    politeness: 'assertive'
  })