adapter.d.ts 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /**
  2. * @license
  3. * Copyright 2020 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 { Action, CloseReason } from './constants';
  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 MDCBannerAdapter {
  32. /**
  33. * Adds the given class to the banner root element.
  34. */
  35. addClass(className: string): void;
  36. /**
  37. * @return Returns the height of the banner content element.
  38. */
  39. getContentHeight(): number;
  40. /**
  41. * Broadcasts an event denoting that the banner has finished closing.
  42. */
  43. notifyClosed(reason: CloseReason): void;
  44. /**
  45. * Broadcasts an event denoting that the banner has just started closing.
  46. */
  47. notifyClosing(reason: CloseReason): void;
  48. /**
  49. * Broadcasts an event denoting that the banner has finished opening.
  50. */
  51. notifyOpened(): void;
  52. /**
  53. * Broadcasts an event denoting that the banner has just started opening.
  54. */
  55. notifyOpening(): void;
  56. /**
  57. * Broadcasts an event denoting that a banner button was clicked without
  58. * changing the banner state.
  59. */
  60. notifyActionClicked(action: Action): void;
  61. /**
  62. * Releases focus from banner and restores focus to the previously focused
  63. * element.
  64. */
  65. releaseFocus(): void;
  66. /**
  67. * Removes the given class from the banner root element.
  68. */
  69. removeClass(className: string): void;
  70. /**
  71. * Sets a style property of the banner root element to the passed value.
  72. */
  73. setStyleProperty(propertyName: string, value: string): void;
  74. /**
  75. * Traps focus in banner and focuses on the primary action button.
  76. */
  77. trapFocus(): void;
  78. }