component.d.ts 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /**
  2. * @license
  3. * Copyright 2018 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 { MDCLineRippleFoundation } from './foundation';
  25. /** MDC Line Ripple Factory */
  26. export declare type MDCLineRippleFactory = (el: HTMLElement, foundation?: MDCLineRippleFoundation) => MDCLineRipple;
  27. /** MDC Line Ripple */
  28. export declare class MDCLineRipple extends MDCComponent<MDCLineRippleFoundation> {
  29. static attachTo(root: HTMLElement): MDCLineRipple;
  30. /**
  31. * Activates the line ripple
  32. */
  33. activate(): void;
  34. /**
  35. * Deactivates the line ripple
  36. */
  37. deactivate(): void;
  38. /**
  39. * Sets the transform origin given a user's click location.
  40. * The `rippleCenter` is the x-coordinate of the middle of the ripple.
  41. */
  42. setRippleCenter(xCoordinate: number): void;
  43. getDefaultFoundation(): MDCLineRippleFoundation;
  44. }