foundation.d.ts 2.9 KB

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