useRouteAnnouncer
このコンポーザブルはページタイトルの変更を監視し、それに応じてアナウンサーメッセージを更新します。
このコンポーザブルは Nuxt v3.12+ で利用可能です。
説明
ページタイトルの変更を監視し、それに応じてアナウンサーメッセージを更新するコンポーザブルです。<NuxtRouteAnnouncer>
によって使用され、制御可能です。Unhead の dom:rendered
にフックしてページのタイトルを読み取り、それをアナウンサーメッセージとして設定します。
パラメータ
politeness
: スクリーンリーダーのアナウンスの緊急度を設定します:off
(アナウンスを無効にする)、polite
(静寂を待つ)、またはassertive
(即座に中断する)。(デフォルトはpolite
)。
プロパティ
message
- type:
Ref<string>
- description: アナウンスするメッセージ
politeness
- type:
Ref<string>
- description: スクリーンリーダーのアナウンス緊急度レベル
off
、polite
、または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'
})
※このページは Nuxt.js 公式ドキュメントの翻訳ページ(非公式)です。
公式ドキュメントの該当ページはこちら:
https://nuxt.com/docs/3.x/api/composables/use-route-announcer