Skip to main content

announce

function announce(
message,
politeness,
timeout): void;

Announce a message to screen readers. Announcer needs to be mounted in the application for this to work.

Parameters

ParameterTypeDefault valueDescription
messageReactNodeundefinedThe message to announce.
politeness"assertive" | "polite"'polite'The politeness level of the announcement.
timeoutnumber5000The time in milliseconds util the message is removed from area-live region.

Returns

void