useRouteAnnouncer

ソース
このコンポーザブルは、ページタイトルの変更を監視し、アナウンサーメッセージをそれに応じて更新します。
このコンポーザブルはNuxt v3.12+で利用可能です。

説明

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

パラメーター

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

プロパティ

message

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

politeness

  • : Ref<string>
  • 説明: スクリーンリーダーによるアナウンスの緊急度レベル off, polite, または assertive

メソッド

set(message, politeness = "polite")

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

polite(message)

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

assertive(message)

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

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