UNPKG

2.23 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 { MDCComponent } from '@material/base/component';
24import { MDCFloatingLabelFoundation } from './foundation';
25export declare type MDCFloatingLabelFactory = (el: Element, foundation?: MDCFloatingLabelFoundation) => MDCFloatingLabel;
26export declare class MDCFloatingLabel extends MDCComponent<MDCFloatingLabelFoundation> {
27 static attachTo(root: Element): MDCFloatingLabel;
28 /**
29 * Styles the label to produce the label shake for errors.
30 * @param shouldShake If true, shakes the label by adding a CSS class; otherwise, stops shaking by removing the class.
31 */
32 shake(shouldShake: boolean): void;
33 /**
34 * Styles the label to float/dock.
35 * @param shouldFloat If true, floats the label by adding a CSS class; otherwise, docks it by removing the class.
36 */
37 float(shouldFloat: boolean): void;
38 /**
39 * Styles the label as required.
40 * @param isRequired If true, adds an asterisk to the label, indicating that it is required.
41 */
42 setRequired(isRequired: boolean): void;
43 getWidth(): number;
44 getDefaultFoundation(): MDCFloatingLabelFoundation;
45}