useRouteAnnouncer

原始檔
此可組合函式觀察頁面標題的變化並相應地更新播報器訊息。
此可組合函式在 Nuxt v3.12+ 中可用。

描述

一個可組合函式,用於觀察頁面標題變化並相應地更新播報器訊息。由 <NuxtRouteAnnouncer> 使用並可控制。它掛鉤到 Unhead 的dom:rendered以讀取頁面標題並將其設定為播報器訊息。

引數

  • politeness:設定螢幕閱讀器播報的緊急程度:off(停用播報)、polite(等待靜默)或 assertive(立即中斷)。(預設 polite)。

屬性

message

  • 型別Ref<string>
  • 描述:要播報的訊息

politeness

  • 型別Ref<string>
  • 描述:螢幕閱讀器播報的緊急程度級別:offpoliteassertive

方法

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>