component.d.ts 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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 { MDCTabScrollerFoundation } from './foundation';
  25. /** MDC Tab Scroller Factory */
  26. export declare type MDCTabScrollerFactory = (el: HTMLElement, foundation?: MDCTabScrollerFoundation) => MDCTabScroller;
  27. /** MDC Tab Scroller */
  28. export declare class MDCTabScroller extends MDCComponent<MDCTabScrollerFoundation> {
  29. static attachTo(root: HTMLElement): MDCTabScroller;
  30. private content;
  31. private area;
  32. private handleInteraction;
  33. private handleTransitionEnd;
  34. initialize(): void;
  35. initialSyncWithDOM(): void;
  36. destroy(): void;
  37. getDefaultFoundation(): MDCTabScrollerFoundation;
  38. /**
  39. * Returns the current visual scroll position
  40. */
  41. getScrollPosition(): number;
  42. /**
  43. * Returns the width of the scroll content
  44. */
  45. getScrollContentWidth(): number;
  46. /**
  47. * Increments the scroll value by the given amount
  48. * @param scrollXIncrement The pixel value by which to increment the scroll
  49. * value
  50. */
  51. incrementScroll(scrollXIncrement: number): void;
  52. /**
  53. * Scrolls to the given pixel position
  54. * @param scrollX The pixel value to scroll to
  55. */
  56. scrollTo(scrollX: number): void;
  57. }