component.d.ts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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 { MDCFoundation } from './foundation';
  24. import { CustomEventListener, EventType, SpecificEventListener } from './types';
  25. /** MDC Component base */
  26. export declare class MDCComponent<FoundationType extends MDCFoundation> {
  27. root: HTMLElement;
  28. static attachTo(root: HTMLElement): MDCComponent<MDCFoundation<{}>>;
  29. protected foundation: FoundationType;
  30. constructor(root: HTMLElement, foundation?: FoundationType, ...args: unknown[]);
  31. initialize(..._args: unknown[]): void;
  32. getDefaultFoundation(): FoundationType;
  33. initialSyncWithDOM(): void;
  34. destroy(): void;
  35. /**
  36. * Wrapper method to add an event listener to the component's root element.
  37. * This is most useful when listening for custom events.
  38. */
  39. listen<K extends EventType>(evtType: K, handler: SpecificEventListener<K>, options?: AddEventListenerOptions | boolean): void;
  40. listen<E extends Event>(evtType: string, handler: CustomEventListener<E>, options?: AddEventListenerOptions | boolean): void;
  41. /**
  42. * Wrapper method to remove an event listener to the component's root element.
  43. * This is most useful when unlistening for custom events.
  44. */
  45. unlisten<K extends EventType>(evtType: K, handler: SpecificEventListener<K>, options?: AddEventListenerOptions | boolean): void;
  46. unlisten<E extends Event>(evtType: string, handler: CustomEventListener<E>, options?: AddEventListenerOptions | boolean): void;
  47. /**
  48. * Fires a cross-browser-compatible custom event from the component root of
  49. * the given type, with the given data.
  50. */
  51. emit<T extends object>(evtType: string, evtData: T, shouldBubble?: boolean): void;
  52. /**
  53. * This is a intermediate fix to allow components to use safevalues. This
  54. * limits setAttribute to setting tabindex, data attributes, and aria
  55. * attributes.
  56. *
  57. * TODO(b/263990206): remove this method and add these directly in each
  58. * component. This will remove this abstraction and make it clear that the
  59. * caller can't set any attribute.
  60. */
  61. protected safeSetAttribute(element: HTMLElement, attribute: string, value: string): void;
  62. }
  63. export default MDCComponent;