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" 设置消息。

示例

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