adapter.d.ts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  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 MDCTabScrollerAdapter {
  31. /**
  32. * Adds the given className to the root element.
  33. * @param className The className to add
  34. */
  35. addClass(className: string): void;
  36. /**
  37. * Removes the given className from the root element.
  38. * @param className The className to remove
  39. */
  40. removeClass(className: string): void;
  41. /**
  42. * Adds the given className to the scroll area element.
  43. * @param className The className to add
  44. */
  45. addScrollAreaClass(className: string): void;
  46. /**
  47. * Returns whether the event target matches given className.
  48. * @param evtTarget The event target
  49. * @param selector The selector to check
  50. */
  51. eventTargetMatchesSelector(evtTarget: EventTarget, selector: string): boolean;
  52. /**
  53. * Sets a style property of the area element to the passed value.
  54. * @param propName The style property name to set
  55. * @param value The style property value
  56. */
  57. setScrollAreaStyleProperty(propName: string, value: string): void;
  58. /**
  59. * Sets a style property of the content element to the passed value.
  60. * @param propName The style property name to set
  61. * @param value The style property value
  62. */
  63. setScrollContentStyleProperty(propName: string, value: string): void;
  64. /**
  65. * Returns the scroll content element's computed style value of the given css
  66. * property `propertyName`. We achieve this via
  67. * `getComputedStyle(...).getPropertyValue(propertyName)`.
  68. */
  69. getScrollContentStyleValue(propertyName: string): string;
  70. /**
  71. * Sets the scrollLeft value of the scroll area element to the passed value.
  72. * @param scrollLeft The new scrollLeft value
  73. */
  74. setScrollAreaScrollLeft(scrollLeft: number): void;
  75. /**
  76. * Returns the scrollLeft value of the scroll area element.
  77. */
  78. getScrollAreaScrollLeft(): number;
  79. /**
  80. * Returns the offsetWidth of the scroll content element.
  81. */
  82. getScrollContentOffsetWidth(): number;
  83. /**
  84. * Returns the offsetWitdth of the scroll area element.
  85. */
  86. getScrollAreaOffsetWidth(): number;
  87. /**
  88. * Returns the bounding client rect of the scroll area element.
  89. */
  90. computeScrollAreaClientRect(): DOMRect;
  91. /**
  92. * Returns the bounding client rect of the scroll content element.
  93. */
  94. computeScrollContentClientRect(): DOMRect;
  95. /**
  96. * Returns the height of the browser's horizontal scrollbars (in px).
  97. */
  98. computeHorizontalScrollbarHeight(): number;
  99. }