component.d.ts 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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 { MDCRippleFactory } from '@material/ripple/component';
  25. import { MDCRippleCapableSurface } from '@material/ripple/types';
  26. import { MDCTabIndicatorFactory } from '@material/tab-indicator/component';
  27. import { MDCTabFoundation } from './foundation';
  28. import { MDCTabDimensions } from './types';
  29. /** MDC Tab Factory */
  30. export declare type MDCTabFactory = (el: HTMLElement, foundation?: MDCTabFoundation) => MDCTab;
  31. /** MDC Tab */
  32. export declare class MDCTab extends MDCComponent<MDCTabFoundation> implements MDCRippleCapableSurface {
  33. static attachTo(root: HTMLElement): MDCTab;
  34. id: string;
  35. private ripple;
  36. private tabIndicator;
  37. private content;
  38. private handleClick;
  39. initialize(rippleFactory?: MDCRippleFactory, tabIndicatorFactory?: MDCTabIndicatorFactory): void;
  40. initialSyncWithDOM(): void;
  41. destroy(): void;
  42. getDefaultFoundation(): MDCTabFoundation;
  43. /**
  44. * Getter for the active state of the tab
  45. */
  46. get active(): boolean;
  47. set focusOnActivate(focusOnActivate: boolean);
  48. /**
  49. * Activates the tab
  50. */
  51. activate(computeIndicatorClientRect?: DOMRect): void;
  52. /**
  53. * Deactivates the tab
  54. */
  55. deactivate(): void;
  56. /**
  57. * Returns the indicator's client rect
  58. */
  59. computeIndicatorClientRect(): DOMRect;
  60. computeDimensions(): MDCTabDimensions;
  61. /**
  62. * Focuses the tab
  63. */
  64. focus(): void;
  65. }