foundation.d.ts 2.8 KB

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