UNPKG

2.87 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2017 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 { MDCTextFieldHelperTextAdapter } from './adapter';
25export declare class MDCTextFieldHelperTextFoundation extends MDCFoundation<MDCTextFieldHelperTextAdapter> {
26 static get cssClasses(): {
27 HELPER_TEXT_PERSISTENT: string;
28 HELPER_TEXT_VALIDATION_MSG: string;
29 ROOT: string;
30 };
31 static get strings(): {
32 ARIA_HIDDEN: string;
33 ROLE: string;
34 ROOT_SELECTOR: string;
35 };
36 /**
37 * See {@link MDCTextFieldHelperTextAdapter} for typing information on parameters and return types.
38 */
39 static get defaultAdapter(): MDCTextFieldHelperTextAdapter;
40 constructor(adapter?: Partial<MDCTextFieldHelperTextAdapter>);
41 getId(): string | null;
42 isVisible(): boolean;
43 /**
44 * Sets the content of the helper text field.
45 */
46 setContent(content: string): void;
47 isPersistent(): boolean;
48 /**
49 * @param isPersistent Sets the persistency of the helper text.
50 */
51 setPersistent(isPersistent: boolean): void;
52 /**
53 * @return whether the helper text acts as an error validation message.
54 */
55 isValidation(): boolean;
56 /**
57 * @param isValidation True to make the helper text act as an error validation message.
58 */
59 setValidation(isValidation: boolean): void;
60 /**
61 * Makes the helper text visible to the screen reader.
62 */
63 showToScreenReader(): void;
64 /**
65 * Sets the validity of the helper text based on the input validity.
66 */
67 setValidity(inputIsValid: boolean): void;
68 /**
69 * Hides the help text from screen readers.
70 */
71 private hide;
72 private refreshAlertRole;
73}
74export default MDCTextFieldHelperTextFoundation;