UNPKG

2.93 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2019 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 * Defines the shape of the adapter expected by the foundation.
25 * Implement this adapter for your framework of choice to delegate updates to
26 * the component in your framework of choice. See architecture documentation
27 * for more details.
28 * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
29 */
30import { MDCResizeObserver, MDCResizeObserverCallback } from './types';
31export interface MDCLinearProgressAdapter {
32 addClass(className: string): void;
33 /**
34 * If available, creates a `ResizeObserver` object, invokes the `#observe`
35 * method on the root element. This is used for an optional performance gains
36 * for the indeterminate animation on modern browsers.
37 *
38 * @param callback The callback to apply to the constructor of the
39 * `ResizeObserver`
40 * @return Returns a `ResizeObserver` that has had `observe` called on the
41 * root element with the given callback. `null` if `ResizeObserver` is not
42 * implemented or polyfilled.
43 */
44 attachResizeObserver(callback: MDCResizeObserverCallback): MDCResizeObserver | null;
45 forceLayout(): void;
46 setBufferBarStyle(styleProperty: string, value: string): void;
47 setPrimaryBarStyle(styleProperty: string, value: string): void;
48 /**
49 * Sets the inline style on the root element.
50 * @param styleProperty The style property to set.
51 * @param value The value the style property should be set to.
52 */
53 setStyle(styleProperty: string, value: string): void;
54 /**
55 * @return The width of the root element.
56 */
57 getWidth(): number;
58 hasClass(className: string): boolean;
59 removeClass(className: string): void;
60 removeAttribute(name: string): void;
61 setAttribute(name: string, value: string): void;
62}