45 lines
1.7 KiB
TypeScript
45 lines
1.7 KiB
TypeScript
|
/**
|
||
|
|
* @license
|
||
|
|
* Copyright 2020 Google Inc.
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
|
|
* of this software and associated documentation files (the "Software"), to deal
|
||
|
|
* in the Software without restriction, including without limitation the rights
|
||
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
|
|
* copies of the Software, and to permit persons to whom the Software is
|
||
|
|
* furnished to do so, subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be included in
|
||
|
|
* all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
|
|
* THE SOFTWARE.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Priorities for the announce function.
|
||
|
|
*/
|
||
|
|
export declare enum AnnouncerPriority {
|
||
|
|
POLITE = "polite",
|
||
|
|
ASSERTIVE = "assertive"
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Options for the announce function.
|
||
|
|
*/
|
||
|
|
export interface AnnouncerMessageOptions {
|
||
|
|
priority?: AnnouncerPriority;
|
||
|
|
ownerDocument?: Document;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Data attribute added to live region element.
|
||
|
|
*/
|
||
|
|
export declare const DATA_MDC_DOM_ANNOUNCE = "data-mdc-dom-announce";
|
||
|
|
/**
|
||
|
|
* Announces the given message with optional priority, defaulting to "polite"
|
||
|
|
*/
|
||
|
|
export declare function announce(message: string, options?: AnnouncerMessageOptions): void;
|