| 1 | /**
|
| 2 | * @license
|
| 3 | * Copyright 2020 Google Inc.
|
| 4 | *
|
| 5 | * Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 6 | * of this software and associated documentation files (the "Software"), to deal
|
| 7 | * in the Software without restriction, including without limitation the rights
|
| 8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 9 | * copies of the Software, and to permit persons to whom the Software is
|
| 10 | * furnished to do so, subject to the following conditions:
|
| 11 | *
|
| 12 | * The above copyright notice and this permission notice shall be included in
|
| 13 | * all copies or substantial portions of the Software.
|
| 14 | *
|
| 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| 21 | * THE SOFTWARE.
|
| 22 | */
|
| 23 | /**
|
| 24 | * Priorities for the announce function.
|
| 25 | */
|
| 26 | export declare enum AnnouncerPriority {
|
| 27 | POLITE = "polite",
|
| 28 | ASSERTIVE = "assertive"
|
| 29 | }
|
| 30 | /**
|
| 31 | * Options for the announce function.
|
| 32 | */
|
| 33 | export interface AnnouncerMessageOptions {
|
| 34 | priority?: AnnouncerPriority;
|
| 35 | ownerDocument?: Document;
|
| 36 | }
|
| 37 | /**
|
| 38 | * Data attribute added to live region element.
|
| 39 | */
|
| 40 | export declare const DATA_MDC_DOM_ANNOUNCE = "data-mdc-dom-announce";
|
| 41 | /**
|
| 42 | * Announces the given message with optional priority, defaulting to "polite"
|
| 43 | */
|
| 44 | export declare function announce(message: string, options?: AnnouncerMessageOptions): void;
|