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>