UNPKG

2.78 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 { MDCFoundation } from './foundation';
24import { CustomEventListener, EventType, SpecificEventListener } from './types';
25export declare class MDCComponent<FoundationType extends MDCFoundation> {
26 root: Element;
27 static attachTo(root: Element): MDCComponent<MDCFoundation<{}>>;
28 protected foundation: FoundationType;
29 constructor(root: Element, foundation?: FoundationType, ...args: unknown[]);
30 initialize(..._args: Array<unknown>): void;
31 getDefaultFoundation(): FoundationType;
32 initialSyncWithDOM(): void;
33 destroy(): void;
34 /**
35 * Wrapper method to add an event listener to the component's root element. This is most useful when
36 * listening for custom events.
37 */
38 listen<K extends EventType>(evtType: K, handler: SpecificEventListener<K>, options?: AddEventListenerOptions | boolean): void;
39 listen<E extends Event>(evtType: string, handler: CustomEventListener<E>, options?: AddEventListenerOptions | boolean): void;
40 /**
41 * Wrapper method to remove an event listener to the component's root element. This is most useful when
42 * unlistening for custom events.
43 */
44 unlisten<K extends EventType>(evtType: K, handler: SpecificEventListener<K>, options?: AddEventListenerOptions | boolean): void;
45 unlisten<E extends Event>(evtType: string, handler: CustomEventListener<E>, options?: AddEventListenerOptions | boolean): void;
46 /**
47 * Fires a cross-browser-compatible custom event from the component root of the given type, with the given data.
48 */
49 emit<T extends object>(evtType: string, evtData: T, shouldBubble?: boolean): void;
50}
51export default MDCComponent;