UNPKG

1.83 kBTypeScriptView Raw
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 * KEY provides normalized string values for keys.
25 */
26export declare const KEY: {
27 UNKNOWN: string;
28 BACKSPACE: string;
29 ENTER: string;
30 SPACEBAR: string;
31 PAGE_UP: string;
32 PAGE_DOWN: string;
33 END: string;
34 HOME: string;
35 ARROW_LEFT: string;
36 ARROW_UP: string;
37 ARROW_RIGHT: string;
38 ARROW_DOWN: string;
39 DELETE: string;
40 ESCAPE: string;
41 TAB: string;
42};
43/**
44 * normalizeKey returns the normalized string for a navigational action.
45 */
46export declare function normalizeKey(evt: KeyboardEvent): string;
47/**
48 * isNavigationEvent returns whether the event is a navigation event
49 */
50export declare function isNavigationEvent(evt: KeyboardEvent): boolean;