adapter.d.ts 2.6 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 { EventType, SpecificEventListener } from '@material/base/types';
  24. import { MDCRipplePoint } from './types';
  25. /**
  26. * Defines the shape of the adapter expected by the foundation.
  27. * Implement this adapter for your framework of choice to delegate updates to
  28. * the component in your framework of choice. See architecture documentation
  29. * for more details.
  30. * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
  31. */
  32. export interface MDCRippleAdapter {
  33. browserSupportsCssVars(): boolean;
  34. isUnbounded(): boolean;
  35. isSurfaceActive(): boolean;
  36. isSurfaceDisabled(): boolean;
  37. addClass(className: string): void;
  38. removeClass(className: string): void;
  39. containsEventTarget(target: EventTarget | null): boolean;
  40. registerInteractionHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  41. deregisterInteractionHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  42. registerDocumentInteractionHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  43. deregisterDocumentInteractionHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  44. registerResizeHandler(handler: SpecificEventListener<'resize'>): void;
  45. deregisterResizeHandler(handler: SpecificEventListener<'resize'>): void;
  46. updateCssVariable(varName: string, value: string | null): void;
  47. computeBoundingRect(): ClientRect;
  48. getWindowPageOffset(): MDCRipplePoint;
  49. }