UNPKG

2.31 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2016 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 */
23import { FocusOptions, FocusTrap } from '@material/dom/focus-trap';
24export declare type MDCDialogFocusTrapFactory = (element: HTMLElement, options: FocusOptions) => FocusTrap;
25export declare function createFocusTrapInstance(surfaceEl: HTMLElement, focusTrapFactory: MDCDialogFocusTrapFactory, initialFocusEl?: HTMLElement): FocusTrap;
26export declare function isScrollable(el: HTMLElement | null): boolean;
27/**
28 * For scrollable content, returns true if the content has not been scrolled
29 * (that is, the scroll content is as the "top"). This is used in full-screen
30 * dialogs, where the scroll divider is expected only to appear once the
31 * content has been scrolled "underneath" the header bar.
32 */
33export declare function isScrollAtTop(el: HTMLElement | null): boolean;
34/**
35 * For scrollable content, returns true if the content has been scrolled all the
36 * way to the bottom. This is used in full-screen dialogs, where the footer
37 * scroll divider is expected only to appear when the content is "cut-off" by
38 * the footer bar.
39 */
40export declare function isScrollAtBottom(el: HTMLElement | null): boolean;
41export declare function areTopsMisaligned(els: HTMLElement[]): boolean;