nuxt logo

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

Nuxt.js
Version:v3.17

<NuxtRouteAnnouncer>

<NuxtRouteAnnouncer> コンポーネントは、ルート変更を支援技術に知らせるためにページタイトルを持つ隠し要素を追加します。

このコンポーネントは Nuxt v3.12+ で利用可能です。

使用方法

<NuxtRouteAnnouncer/>app.vue または layouts/ に追加して、支援技術にページタイトルの変更を知らせることでアクセシビリティを向上させます。これにより、スクリーンリーダーに依存するユーザーにナビゲーションの変更が通知されます。

app.vue
<template>
  <NuxtRouteAnnouncer />
  <NuxtLayout>
    <NuxtPage />
  </NuxtLayout>
</template>

スロット

ルートアナウンサーのデフォルトスロットを通じてカスタムHTMLやコンポーネントを渡すことができます。

  <template>
    <NuxtRouteAnnouncer>
      <template #default="{ message }">
        <p>{{ message }} was loaded.</p>
      </template>
    </NuxtRouteAnnouncer>
  </template>

プロパティ

  • atomic: スクリーンリーダーが変更のみを通知するか、全コンテンツを通知するかを制御します。更新時に全コンテンツを読み上げるには true に設定し、変更のみの場合は false にします。(デフォルトは false
  • politeness: スクリーンリーダーの通知の緊急度を設定します:off(通知を無効)、polite(静寂を待つ)、または assertive(即座に中断)。(デフォルトは polite

このコンポーネントはオプションです。 :br 完全なカスタマイズを実現するには、ソースコードに基づいて独自のものを実装できます。

useRouteAnnouncer composable を使用して、基礎となるアナウンサーインスタンスにフックし、カスタムの通知メッセージを設定できます。