| 1 | /**
|
| 2 | * @license
|
| 3 | * Copyright 2018 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 | import { EventType, SpecificEventListener } from '@material/base/types';
|
| 24 | /**
|
| 25 | * Defines the shape of the adapter expected by the foundation.
|
| 26 | * Implement this adapter for your framework of choice to delegate updates to
|
| 27 | * the component in your framework of choice. See architecture documentation
|
| 28 | * for more details.
|
| 29 | * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
|
| 30 | */
|
| 31 | export interface MDCLineRippleAdapter {
|
| 32 | /**
|
| 33 | * Adds a class to the line ripple element.
|
| 34 | */
|
| 35 | addClass(className: string): void;
|
| 36 | /**
|
| 37 | * Removes a class from the line ripple element.
|
| 38 | */
|
| 39 | removeClass(className: string): void;
|
| 40 | hasClass(className: string): boolean;
|
| 41 | /**
|
| 42 | * Sets the style property with propertyName to value on the root element.
|
| 43 | */
|
| 44 | setStyle(propertyName: string, value: string): void;
|
| 45 | /**
|
| 46 | * Registers an event listener on the line ripple element for a given event.
|
| 47 | */
|
| 48 | registerEventHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
|
| 49 | /**
|
| 50 | * Deregisters an event listener on the line ripple element for a given event.
|
| 51 | */
|
| 52 | deregisterEventHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
|
| 53 | }
|