component.d.ts 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  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 { MDCRippleAdapter } from './adapter';
  25. import { MDCRippleFoundation } from './foundation';
  26. import { MDCRippleAttachOpts, MDCRippleCapableSurface } from './types';
  27. /** MDC Ripple Factory */
  28. export declare type MDCRippleFactory = (el: HTMLElement, foundation?: MDCRippleFoundation) => MDCRipple;
  29. /** MDC Ripple */
  30. export declare class MDCRipple extends MDCComponent<MDCRippleFoundation> implements MDCRippleCapableSurface {
  31. static attachTo(root: HTMLElement, opts?: MDCRippleAttachOpts): MDCRipple;
  32. static createAdapter(instance: MDCRippleCapableSurface): MDCRippleAdapter;
  33. disabled: boolean;
  34. private isUnbounded?;
  35. get unbounded(): boolean;
  36. set unbounded(unbounded: boolean);
  37. activate(): void;
  38. deactivate(): void;
  39. layout(): void;
  40. getDefaultFoundation(): MDCRippleFoundation;
  41. initialSyncWithDOM(): void;
  42. /**
  43. * Closure Compiler throws an access control error when directly accessing a
  44. * protected or private property inside a getter/setter, like unbounded above.
  45. * By accessing the protected property inside a method, we solve that problem.
  46. * That's why this function exists.
  47. */
  48. private setUnbounded;
  49. }