UNPKG

13.1 kBTypeScriptView Raw
1// Generated by dts-bundle v0.7.3
2// Dependencies for this module:
3// ../../@material/base/component
4// ../../@material/progress-indicator/component
5// ../../@material/base/foundation
6// ../../@material/progress-indicator/foundation
7
8declare module '@material/linear-progress' {
9 /**
10 * @license
11 * Copyright 2019 Google Inc.
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a copy
14 * of this software and associated documentation files (the "Software"), to deal
15 * in the Software without restriction, including without limitation the rights
16 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17 * copies of the Software, and to permit persons to whom the Software is
18 * furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 * THE SOFTWARE.
30 */
31 export * from '@material/linear-progress/adapter';
32 export * from '@material/linear-progress/component';
33 export * from '@material/linear-progress/constants';
34 export * from '@material/linear-progress/foundation';
35 export * from '@material/linear-progress/types';
36}
37
38declare module '@material/linear-progress/adapter' {
39 /**
40 * Defines the shape of the adapter expected by the foundation.
41 * Implement this adapter for your framework of choice to delegate updates to
42 * the component in your framework of choice. See architecture documentation
43 * for more details.
44 * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
45 */
46 import { MDCResizeObserver, MDCResizeObserverCallback } from '@material/linear-progress/types';
47 export interface MDCLinearProgressAdapter {
48 addClass(className: string): void;
49 /**
50 * If available, creates a `ResizeObserver` object, invokes the `#observe`
51 * method on the root element. This is used for an optional performance gains
52 * for the indeterminate animation on modern browsers.
53 *
54 * @param callback The callback to apply to the constructor of the
55 * `ResizeObserver`
56 * @return Returns a `ResizeObserver` that has had `observe` called on the
57 * root element with the given callback. `null` if `ResizeObserver` is not
58 * implemented or polyfilled.
59 */
60 attachResizeObserver(callback: MDCResizeObserverCallback): MDCResizeObserver | null;
61 forceLayout(): void;
62 setBufferBarStyle(styleProperty: string, value: string): void;
63 setPrimaryBarStyle(styleProperty: string, value: string): void;
64 /**
65 * Sets the inline style on the root element.
66 * @param styleProperty The style property to set.
67 * @param value The value the style property should be set to.
68 */
69 setStyle(styleProperty: string, value: string): void;
70 /**
71 * @return The width of the root element.
72 */
73 getWidth(): number;
74 hasClass(className: string): boolean;
75 removeClass(className: string): void;
76 removeAttribute(name: string): void;
77 setAttribute(name: string, value: string): void;
78 }
79}
80
81declare module '@material/linear-progress/component' {
82 /**
83 * @license
84 * Copyright 2017 Google Inc.
85 *
86 * Permission is hereby granted, free of charge, to any person obtaining a copy
87 * of this software and associated documentation files (the "Software"), to deal
88 * in the Software without restriction, including without limitation the rights
89 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
90 * copies of the Software, and to permit persons to whom the Software is
91 * furnished to do so, subject to the following conditions:
92 *
93 * The above copyright notice and this permission notice shall be included in
94 * all copies or substantial portions of the Software.
95 *
96 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
97 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
98 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
99 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
100 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
101 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
102 * THE SOFTWARE.
103 */
104 import { MDCComponent } from '@material/base/component';
105 import { MDCProgressIndicator } from '@material/progress-indicator/component';
106 import { MDCLinearProgressFoundation } from '@material/linear-progress/foundation';
107 export class MDCLinearProgress extends MDCComponent<MDCLinearProgressFoundation> implements MDCProgressIndicator {
108 static attachTo(root: Element): MDCLinearProgress;
109 set determinate(value: boolean);
110 set progress(value: number);
111 set buffer(value: number);
112 open(): void;
113 close(): void;
114 initialSyncWithDOM(): void;
115 getDefaultFoundation(): MDCLinearProgressFoundation;
116 }
117}
118
119declare module '@material/linear-progress/constants' {
120 /**
121 * @license
122 * Copyright 2017 Google Inc.
123 *
124 * Permission is hereby granted, free of charge, to any person obtaining a copy
125 * of this software and associated documentation files (the "Software"), to deal
126 * in the Software without restriction, including without limitation the rights
127 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
128 * copies of the Software, and to permit persons to whom the Software is
129 * furnished to do so, subject to the following conditions:
130 *
131 * The above copyright notice and this permission notice shall be included in
132 * all copies or substantial portions of the Software.
133 *
134 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
135 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
136 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
137 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
138 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
139 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
140 * THE SOFTWARE.
141 */
142 export const cssClasses: {
143 CLOSED_CLASS: string;
144 CLOSED_ANIMATION_OFF_CLASS: string;
145 INDETERMINATE_CLASS: string;
146 REVERSED_CLASS: string;
147 ANIMATION_READY_CLASS: string;
148 };
149 export const strings: {
150 ARIA_HIDDEN: string;
151 ARIA_VALUEMAX: string;
152 ARIA_VALUEMIN: string;
153 ARIA_VALUENOW: string;
154 BUFFER_BAR_SELECTOR: string;
155 FLEX_BASIS: string;
156 PRIMARY_BAR_SELECTOR: string;
157 };
158 export const animationDimensionPercentages: {
159 PRIMARY_HALF: number;
160 PRIMARY_FULL: number;
161 SECONDARY_QUARTER: number;
162 SECONDARY_HALF: number;
163 SECONDARY_FULL: number;
164 };
165}
166
167declare module '@material/linear-progress/foundation' {
168 /**
169 * @license
170 * Copyright 2017 Google Inc.
171 *
172 * Permission is hereby granted, free of charge, to any person obtaining a copy
173 * of this software and associated documentation files (the "Software"), to deal
174 * in the Software without restriction, including without limitation the rights
175 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
176 * copies of the Software, and to permit persons to whom the Software is
177 * furnished to do so, subject to the following conditions:
178 *
179 * The above copyright notice and this permission notice shall be included in
180 * all copies or substantial portions of the Software.
181 *
182 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
183 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
184 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
185 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
186 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
187 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
188 * THE SOFTWARE.
189 */
190 import { MDCFoundation } from '@material/base/foundation';
191 import { MDCProgressIndicatorFoundation } from '@material/progress-indicator/foundation';
192 import { MDCLinearProgressAdapter } from '@material/linear-progress/adapter';
193 export class MDCLinearProgressFoundation extends MDCFoundation<MDCLinearProgressAdapter> implements MDCProgressIndicatorFoundation {
194 static get cssClasses(): {
195 CLOSED_CLASS: string;
196 CLOSED_ANIMATION_OFF_CLASS: string;
197 INDETERMINATE_CLASS: string;
198 REVERSED_CLASS: string;
199 ANIMATION_READY_CLASS: string;
200 };
201 static get strings(): {
202 ARIA_HIDDEN: string;
203 ARIA_VALUEMAX: string;
204 ARIA_VALUEMIN: string;
205 ARIA_VALUENOW: string;
206 BUFFER_BAR_SELECTOR: string;
207 FLEX_BASIS: string;
208 PRIMARY_BAR_SELECTOR: string;
209 };
210 static get defaultAdapter(): MDCLinearProgressAdapter;
211 constructor(adapter?: Partial<MDCLinearProgressAdapter>);
212 init(): void;
213 setDeterminate(isDeterminate: boolean): void;
214 isDeterminate(): boolean;
215 setProgress(value: number): void;
216 getProgress(): number;
217 setBuffer(value: number): void;
218 getBuffer(): number;
219 open(): void;
220 close(): void;
221 isClosed(): boolean;
222 /**
223 * Handles the transitionend event emitted after `close()` is called and the
224 * opacity fades out. This is so that animations are removed only after the
225 * progress indicator is completely hidden.
226 */
227 handleTransitionEnd(): void;
228 destroy(): void;
229 restartAnimation(): void;
230 }
231 export default MDCLinearProgressFoundation;
232}
233
234declare module '@material/linear-progress/types' {
235 /**
236 * @license
237 * Copyright 2021 Google Inc.
238 *
239 * Permission is hereby granted, free of charge, to any person obtaining a copy
240 * of this software and associated documentation files (the "Software"), to deal
241 * in the Software without restriction, including without limitation the rights
242 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
243 * copies of the Software, and to permit persons to whom the Software is
244 * furnished to do so, subject to the following conditions:
245 *
246 * The above copyright notice and this permission notice shall be included in
247 * all copies or substantial portions of the Software.
248 *
249 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
250 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
251 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
252 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
253 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
254 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
255 * THE SOFTWARE.
256 */
257 export interface MDCResizeObserverEntry {
258 contentRect: DOMRectReadOnly;
259 }
260 export interface MDCResizeObserver {
261 new (callback: MDCResizeObserverCallback): MDCResizeObserver;
262 disconnect(): void;
263 observe(target: Element): void;
264 }
265 export interface WithMDCResizeObserver {
266 ResizeObserver: MDCResizeObserver;
267 }
268 export type MDCResizeObserverCallback = (entries: MDCResizeObserverEntry[], observer: MDCResizeObserver) => void;
269}
270