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
| Parameter | Type | Default value | Description |
|---|---|---|---|
message | ReactNode | undefined | The message to announce. |
politeness | "assertive" | "polite" | 'polite' | The politeness level of the announcement. |
timeout | number | 5000 | The time in milliseconds util the message is removed from area-live region. |
Returns
void