adapter.d.ts 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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. /**
  24. * Defines the shape of the adapter expected by the foundation.
  25. * Implement this adapter for your framework of choice to delegate updates to
  26. * the component in your framework of choice. See architecture documentation
  27. * for more details.
  28. * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
  29. */
  30. export interface MDCTopAppBarAdapter {
  31. /**
  32. * Adds a class to the root Element.
  33. */
  34. addClass(className: string): void;
  35. /**
  36. * Removes a class from the root Element.
  37. */
  38. removeClass(className: string): void;
  39. /**
  40. * Returns true if the root Element contains the given class.
  41. */
  42. hasClass(className: string): boolean;
  43. /**
  44. * Sets the specified inline style property on the root Element to the given
  45. * value.
  46. */
  47. setStyle(property: string, value: string): void;
  48. /**
  49. * Gets the height of the top app bar.
  50. */
  51. getTopAppBarHeight(): number;
  52. getViewportScrollY(): number;
  53. getTotalActionItems(): number;
  54. /**
  55. * Emits an event when the navigation icon is clicked.
  56. */
  57. notifyNavigationIconClicked(): void;
  58. }