adapter.d.ts 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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 { EventType, SpecificEventListener, SpecificWindowEventListener, WindowEventType } from '@material/base/types';
  24. /**
  25. * Defines the shape of the adapter expected by the foundation.
  26. * Implement this adapter for your framework of choice to delegate updates to
  27. * the component in your framework of choice. See architecture documentation
  28. * for more details.
  29. * https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md
  30. */
  31. export interface MDCDialogAdapter {
  32. addClass(className: string): void;
  33. removeClass(className: string): void;
  34. hasClass(className: string): boolean;
  35. addBodyClass(className: string): void;
  36. removeBodyClass(className: string): void;
  37. eventTargetMatches(target: EventTarget | null, selector: string): boolean;
  38. isContentScrollable(): boolean;
  39. areButtonsStacked(): boolean;
  40. getActionFromEvent(evt: Event): string | null;
  41. trapFocus(focusElement: HTMLElement | null): void;
  42. releaseFocus(): void;
  43. getInitialFocusEl(): HTMLElement | null;
  44. clickDefaultButton(): void;
  45. reverseButtons(): void;
  46. notifyOpening(): void;
  47. notifyOpened(): void;
  48. notifyClosing(action: string): void;
  49. notifyClosed(action: string): void;
  50. /**
  51. * Registers an event listener on the dialog's content element (indicated
  52. * with the 'mdc-dialog__content' class).
  53. */
  54. registerContentEventHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  55. /**
  56. * Deregisters an event listener on the dialog's content element.
  57. */
  58. deregisterContentEventHandler<K extends EventType>(evtType: K, handler: SpecificEventListener<K>): void;
  59. /**
  60. * @return true if the content has been scrolled (that is, for
  61. * scrollable content, if it is at the "top"). This is used in full-screen
  62. * dialogs, where the scroll divider is expected only to appear once the
  63. * content has been scrolled "underneath" the header bar.
  64. */
  65. isScrollableContentAtTop(): boolean;
  66. /**
  67. * @return true if the content has been scrolled all
  68. * the way to the bottom. This is used in full-screen dialogs, where the
  69. * footer scroll divider is expected only to appear when the content is
  70. * "cut-off" by the footer bar.
  71. */
  72. isScrollableContentAtBottom(): boolean;
  73. /**
  74. * Registers an event listener to the window.
  75. */
  76. registerWindowEventHandler<K extends WindowEventType>(evtType: K, handler: SpecificWindowEventListener<K>): void;
  77. /**
  78. * Deregisters an event listener to the window.
  79. */
  80. deregisterWindowEventHandler<K extends WindowEventType>(evtType: K, handler: SpecificWindowEventListener<K>): void;
  81. }