Interface Announcer

interface Announcer {
    element: HTMLElement;
    announce(message: string, priority?: AnnouncePriority): void;
    clear(): void;
    destroy(): void;
}

Index

Properties

Methods

announce clear destroy

Properties

`Readonly`element

element: HTMLElement

The live regions, appended wherever the announcer was told to live.

Methods

announce

announce(message: string, priority?: AnnouncePriority): void
Say something. Repeating the same text still announces it.
Parameters
- message: string
- Optionalpriority: AnnouncePriority
Returns void
- Defined in packages/core/src/a11y/announce.ts:22

clear

clear(): void
Empty both regions without saying anything.

Returns void
- Defined in packages/core/src/a11y/announce.ts:24

destroy

destroy(): void
Returns void
- Defined in packages/core/src/a11y/announce.ts:25