adapter.d.ts 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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 MDCDrawerAdapter {
  31. /**
  32. * Adds a class to the root Element.
  33. */
  34. addClass(className: string): void;
  35. /**
  36. * Removes a class from the root Element.
  37. */
  38. removeClass(className: string): void;
  39. /**
  40. * Returns true if the root Element contains the given class.
  41. */
  42. hasClass(className: string): boolean;
  43. /**
  44. * Returns true if the element contains the given class.
  45. * @param element target element to verify class name
  46. * @param className class name
  47. */
  48. elementHasClass(element: Element, className: string): boolean;
  49. /**
  50. * Saves the focus of currently active element.
  51. */
  52. saveFocus(): void;
  53. /**
  54. * Restores focus to element previously saved with 'saveFocus'.
  55. */
  56. restoreFocus(): void;
  57. /**
  58. * Focuses the active / selected navigation item.
  59. */
  60. focusActiveNavigationItem(): void;
  61. /**
  62. * Emits a custom event "MDCDrawer:closed" denoting the drawer has closed.
  63. */
  64. notifyClose(): void;
  65. /**
  66. * Emits a custom event "MDCDrawer:opened" denoting the drawer has opened.
  67. */
  68. notifyOpen(): void;
  69. /**
  70. * Traps focus on root element and focuses the active navigation element.
  71. */
  72. trapFocus(): void;
  73. /**
  74. * Releases focus trap from root element which was set by `trapFocus`
  75. * and restores focus to where it was prior to calling `trapFocus`.
  76. */
  77. releaseFocus(): void;
  78. }