Skip to content

UseAnnounce

method
cref: M:Microsoft.UI.Reactor.Hooks.UseAnnounceExtensions.UseAnnounce(Microsoft.UI.Reactor.Core.Component)

Learn more: Hooks, Effects

Overloads

UseAnnounce(Component)

method
cref: M:Microsoft.UI.Reactor.Hooks.UseAnnounceExtensions.UseAnnounce(Microsoft.UI.Reactor.Core.Component)

Summary

Creates an AnnounceHandle (guide) for making screen reader announcements.

UseAnnounce(RenderContext)

method
cref: M:Microsoft.UI.Reactor.Hooks.UseAnnounceExtensions.UseAnnounce(Microsoft.UI.Reactor.Core.RenderContext)

Summary

Creates an AnnounceHandle (guide) for making screen reader announcements. The handle persists across re-renders.

You must include Region (guide) in your rendered tree:

var announce = UseAnnounce();
return VStack(
announce.Region,
Button("Save", () => { Save(); announce.Announce("Document saved"); }),
);