component.d.ts 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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 { MDCComponent } from '@material/base/component';
  24. import { CloseReason, MDCBannerFocusTrapFactory } from './constants';
  25. import { MDCBannerFoundation } from './foundation';
  26. /** Vanilla implementation of banner component. */
  27. export declare class MDCBanner extends MDCComponent<MDCBannerFoundation> {
  28. static attachTo(root: HTMLElement): MDCBanner;
  29. private handleContentClick;
  30. private primaryActionEl;
  31. private secondaryActionEl;
  32. private textEl;
  33. private contentEl;
  34. private focusTrap;
  35. private focusTrapFactory;
  36. initialize(focusTrapFactory?: MDCBannerFocusTrapFactory): void;
  37. initialSyncWithDOM(): void;
  38. destroy(): void;
  39. layout(): void;
  40. /**
  41. * Opens the banner and fires events.OPENING to indicate the beginning of its
  42. * opening animation and then events.OPENED once the animation finishes.
  43. */
  44. open(): void;
  45. /**
  46. * Closes the banner and fires events.CLOSING to indicate the beginning of its
  47. * closing animation and then events.CLOSED once the animation finishes.
  48. * @param reason Why the banner was closed. Value will be passed to
  49. * events.CLOSING and events.CLOSED via the `event.detail.reason`
  50. * property. Standard values are CloseReason.PRIMARY and
  51. * CloseReason.SECONDARY, but CloseReason.UNSPECIFIED is provided for
  52. * custom handling of programmatic closing of the banner.
  53. */
  54. close(reason: CloseReason): void;
  55. getDefaultFoundation(): MDCBannerFoundation;
  56. get isOpen(): boolean;
  57. getText(): string;
  58. setText(text: string): void;
  59. getPrimaryActionText(): string;
  60. setPrimaryActionText(actionButtonText: string): void;
  61. /** Returns null if the banner has no secondary action. */
  62. getSecondaryActionText(): string | null;
  63. setSecondaryActionText(actionButtonText: string): void;
  64. private registerContentClickHandler;
  65. private deregisterContentClickHandler;
  66. }