UNPKG

2.62 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 '@material/base/foundation';
24import { MDCFloatingLabelAdapter } from './adapter';
25export declare class MDCFloatingLabelFoundation extends MDCFoundation<MDCFloatingLabelAdapter> {
26 static get cssClasses(): {
27 LABEL_FLOAT_ABOVE: string;
28 LABEL_REQUIRED: string;
29 LABEL_SHAKE: string;
30 ROOT: string;
31 };
32 /**
33 * See {@link MDCFloatingLabelAdapter} for typing information on parameters and return types.
34 */
35 static get defaultAdapter(): MDCFloatingLabelAdapter;
36 private readonly shakeAnimationEndHandler;
37 constructor(adapter?: Partial<MDCFloatingLabelAdapter>);
38 init(): void;
39 destroy(): void;
40 /**
41 * Returns the width of the label element.
42 */
43 getWidth(): number;
44 /**
45 * Styles the label to produce a shake animation to indicate an error.
46 * @param shouldShake If true, adds the shake CSS class; otherwise, removes shake class.
47 */
48 shake(shouldShake: boolean): void;
49 /**
50 * Styles the label to float or dock.
51 * @param shouldFloat If true, adds the float CSS class; otherwise, removes float and shake classes to dock the label.
52 */
53 float(shouldFloat: boolean): void;
54 /**
55 * Styles the label as required.
56 * @param isRequired If true, adds an asterisk to the label, indicating that it is required.
57 */
58 setRequired(isRequired: boolean): void;
59 private handleShakeAnimationEnd;
60}
61export default MDCFloatingLabelFoundation;