useRouteAnnouncer
此组合式 API 观察页面标题变化并相应更新播报消息。
此组合式 API 适用于 Nuxt v3.12+。
描述
一个观察页面标题变化并相应更新播报消息的组合式 API。由 <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"
设置消息。
示例
pages/index.vue
<script setup lang="ts">
const { message, politeness, set, polite, assertive } = useRouteAnnouncer({
politeness: 'assertive'
})
</script>