component.d.ts 2.3 KB

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