UNPKG

16.2 kBTypeScriptView Raw
1// Generated by dts-bundle v0.7.3
2// Dependencies for this module:
3// ../../@material/base/component
4// ../../@material/ripple/component
5// ../../@material/base/foundation
6
7declare module '@material/top-app-bar' {
8 /**
9 * @license
10 * Copyright 2019 Google Inc.
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 * THE SOFTWARE.
29 */
30 export * from '@material/top-app-bar/adapter';
31 export * from '@material/top-app-bar/component';
32 export * from '@material/top-app-bar/constants';
33 export * from '@material/top-app-bar/foundation';
34 export * from '@material/top-app-bar/fixed/foundation';
35 export * from '@material/top-app-bar/short/foundation';
36 export * from '@material/top-app-bar/standard/foundation';
37}
38
39declare module '@material/top-app-bar/adapter' {
40 /**
41 * Defines the shape of the adapter expected by the foundation.
42 * Implement this adapter for your framework of choice to delegate updates to
43 * the component in your framework of choice. See architecture documentation
44 * for more details.
45 * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
46 */
47 export interface MDCTopAppBarAdapter {
48 /**
49 * Adds a class to the root Element.
50 */
51 addClass(className: string): void;
52 /**
53 * Removes a class from the root Element.
54 */
55 removeClass(className: string): void;
56 /**
57 * Returns true if the root Element contains the given class.
58 */
59 hasClass(className: string): boolean;
60 /**
61 * Sets the specified inline style property on the root Element to the given value.
62 */
63 setStyle(property: string, value: string): void;
64 /**
65 * Gets the height of the top app bar.
66 */
67 getTopAppBarHeight(): number;
68 getViewportScrollY(): number;
69 getTotalActionItems(): number;
70 /**
71 * Emits an event when the navigation icon is clicked.
72 */
73 notifyNavigationIconClicked(): void;
74 }
75}
76
77declare module '@material/top-app-bar/component' {
78 /**
79 * @license
80 * Copyright 2018 Google Inc.
81 *
82 * Permission is hereby granted, free of charge, to any person obtaining a copy
83 * of this software and associated documentation files (the "Software"), to deal
84 * in the Software without restriction, including without limitation the rights
85 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
86 * copies of the Software, and to permit persons to whom the Software is
87 * furnished to do so, subject to the following conditions:
88 *
89 * The above copyright notice and this permission notice shall be included in
90 * all copies or substantial portions of the Software.
91 *
92 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
93 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
94 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
95 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
96 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
97 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
98 * THE SOFTWARE.
99 */
100 import { MDCComponent } from '@material/base/component';
101 import { MDCRippleFactory } from '@material/ripple/component';
102 import { MDCTopAppBarBaseFoundation } from '@material/top-app-bar/foundation';
103 export class MDCTopAppBar extends MDCComponent<MDCTopAppBarBaseFoundation> {
104 static attachTo(root: Element): MDCTopAppBar;
105 initialize(rippleFactory?: MDCRippleFactory): void;
106 initialSyncWithDOM(): void;
107 destroy(): void;
108 setScrollTarget(target: EventTarget): void;
109 getDefaultFoundation(): MDCTopAppBarBaseFoundation;
110 }
111}
112
113declare module '@material/top-app-bar/constants' {
114 /**
115 * @license
116 * Copyright 2018 Google Inc.
117 *
118 * Permission is hereby granted, free of charge, to any person obtaining a copy
119 * of this software and associated documentation files (the "Software"), to deal
120 * in the Software without restriction, including without limitation the rights
121 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
122 * copies of the Software, and to permit persons to whom the Software is
123 * furnished to do so, subject to the following conditions:
124 *
125 * The above copyright notice and this permission notice shall be included in
126 * all copies or substantial portions of the Software.
127 *
128 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
129 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
130 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
131 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
132 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
133 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
134 * THE SOFTWARE.
135 */
136 const cssClasses: {
137 FIXED_CLASS: string;
138 FIXED_SCROLLED_CLASS: string;
139 SHORT_CLASS: string;
140 SHORT_COLLAPSED_CLASS: string;
141 SHORT_HAS_ACTION_ITEM_CLASS: string;
142 };
143 const numbers: {
144 DEBOUNCE_THROTTLE_RESIZE_TIME_MS: number;
145 MAX_TOP_APP_BAR_HEIGHT: number;
146 };
147 const strings: {
148 ACTION_ITEM_SELECTOR: string;
149 NAVIGATION_EVENT: string;
150 NAVIGATION_ICON_SELECTOR: string;
151 ROOT_SELECTOR: string;
152 TITLE_SELECTOR: string;
153 };
154 export { cssClasses, numbers, strings };
155}
156
157declare module '@material/top-app-bar/foundation' {
158 /**
159 * @license
160 * Copyright 2018 Google Inc.
161 *
162 * Permission is hereby granted, free of charge, to any person obtaining a copy
163 * of this software and associated documentation files (the "Software"), to deal
164 * in the Software without restriction, including without limitation the rights
165 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
166 * copies of the Software, and to permit persons to whom the Software is
167 * furnished to do so, subject to the following conditions:
168 *
169 * The above copyright notice and this permission notice shall be included in
170 * all copies or substantial portions of the Software.
171 *
172 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
173 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
174 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
175 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
176 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
177 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
178 * THE SOFTWARE.
179 */
180 import { MDCFoundation } from '@material/base/foundation';
181 import { MDCTopAppBarAdapter } from '@material/top-app-bar/adapter';
182 export class MDCTopAppBarBaseFoundation extends MDCFoundation<MDCTopAppBarAdapter> {
183 static get strings(): {
184 ACTION_ITEM_SELECTOR: string;
185 NAVIGATION_EVENT: string;
186 NAVIGATION_ICON_SELECTOR: string;
187 ROOT_SELECTOR: string;
188 TITLE_SELECTOR: string;
189 };
190 static get cssClasses(): {
191 FIXED_CLASS: string;
192 FIXED_SCROLLED_CLASS: string;
193 SHORT_CLASS: string;
194 SHORT_COLLAPSED_CLASS: string;
195 SHORT_HAS_ACTION_ITEM_CLASS: string;
196 };
197 static get numbers(): {
198 DEBOUNCE_THROTTLE_RESIZE_TIME_MS: number;
199 MAX_TOP_APP_BAR_HEIGHT: number;
200 };
201 /**
202 * See {@link MDCTopAppBarAdapter} for typing information on parameters and return types.
203 */
204 static get defaultAdapter(): MDCTopAppBarAdapter;
205 constructor(adapter?: Partial<MDCTopAppBarAdapter>);
206 /** Other variants of TopAppBar foundation overrides this method */
207 handleTargetScroll(): void;
208 /** Other variants of TopAppBar foundation overrides this method */
209 handleWindowResize(): void;
210 handleNavigationClick(): void;
211 }
212 export default MDCTopAppBarBaseFoundation;
213}
214
215declare module '@material/top-app-bar/fixed/foundation' {
216 /**
217 * @license
218 * Copyright 2018 Google Inc.
219 *
220 * Permission is hereby granted, free of charge, to any person obtaining a copy
221 * of this software and associated documentation files (the "Software"), to deal
222 * in the Software without restriction, including without limitation the rights
223 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
224 * copies of the Software, and to permit persons to whom the Software is
225 * furnished to do so, subject to the following conditions:
226 *
227 * The above copyright notice and this permission notice shall be included in
228 * all copies or substantial portions of the Software.
229 *
230 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
231 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
232 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
233 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
234 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
235 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
236 * THE SOFTWARE.
237 */
238 import { MDCTopAppBarFoundation } from '@material/top-app-bar/standard/foundation';
239 export class MDCFixedTopAppBarFoundation extends MDCTopAppBarFoundation {
240 /**
241 * Scroll handler for applying/removing the modifier class on the fixed top app bar.
242 * @override
243 */
244 handleTargetScroll(): void;
245 }
246 export default MDCFixedTopAppBarFoundation;
247}
248
249declare module '@material/top-app-bar/short/foundation' {
250 /**
251 * @license
252 * Copyright 2018 Google Inc.
253 *
254 * Permission is hereby granted, free of charge, to any person obtaining a copy
255 * of this software and associated documentation files (the "Software"), to deal
256 * in the Software without restriction, including without limitation the rights
257 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
258 * copies of the Software, and to permit persons to whom the Software is
259 * furnished to do so, subject to the following conditions:
260 *
261 * The above copyright notice and this permission notice shall be included in
262 * all copies or substantial portions of the Software.
263 *
264 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
265 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
266 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
267 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
268 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
269 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
270 * THE SOFTWARE.
271 */
272 import { MDCTopAppBarAdapter } from '@material/top-app-bar/adapter';
273 import { MDCTopAppBarBaseFoundation } from '@material/top-app-bar/foundation';
274 export class MDCShortTopAppBarFoundation extends MDCTopAppBarBaseFoundation {
275 get isCollapsed(): boolean;
276 constructor(adapter?: Partial<MDCTopAppBarAdapter>);
277 init(): void;
278 /**
279 * Set if the short top app bar should always be collapsed.
280 *
281 * @param value When `true`, bar will always be collapsed. When `false`, bar may collapse or expand based on scroll.
282 */
283 setAlwaysCollapsed(value: boolean): void;
284 getAlwaysCollapsed(): boolean;
285 /**
286 * Scroll handler for applying/removing the collapsed modifier class on the short top app bar.
287 * @override
288 */
289 handleTargetScroll(): void;
290 }
291 export default MDCShortTopAppBarFoundation;
292}
293
294declare module '@material/top-app-bar/standard/foundation' {
295 /**
296 * @license
297 * Copyright 2018 Google Inc.
298 *
299 * Permission is hereby granted, free of charge, to any person obtaining a copy
300 * of this software and associated documentation files (the "Software"), to deal
301 * in the Software without restriction, including without limitation the rights
302 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
303 * copies of the Software, and to permit persons to whom the Software is
304 * furnished to do so, subject to the following conditions:
305 *
306 * The above copyright notice and this permission notice shall be included in
307 * all copies or substantial portions of the Software.
308 *
309 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
310 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
311 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
312 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
313 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
314 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
315 * THE SOFTWARE.
316 */
317 import { MDCTopAppBarAdapter } from '@material/top-app-bar/adapter';
318 import { MDCTopAppBarBaseFoundation } from '@material/top-app-bar/foundation';
319 export class MDCTopAppBarFoundation extends MDCTopAppBarBaseFoundation {
320 constructor(adapter?: Partial<MDCTopAppBarAdapter>);
321 destroy(): void;
322 /**
323 * Scroll handler for the default scroll behavior of the top app bar.
324 * @override
325 */
326 handleTargetScroll(): void;
327 /**
328 * Top app bar resize handler that throttle/debounce functions that execute updates.
329 * @override
330 */
331 handleWindowResize(): void;
332 }
333 export default MDCTopAppBarFoundation;
334}
335