foundation.d.ts 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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 { MDCFoundation } from '@material/base/foundation';
  24. import { MDCBannerAdapter } from './adapter';
  25. import { CloseReason } from './constants';
  26. /**
  27. * Foundation class for banner. Responsibilities include opening and closing the
  28. * banner.
  29. */
  30. export declare class MDCBannerFoundation extends MDCFoundation<MDCBannerAdapter> {
  31. static get defaultAdapter(): MDCBannerAdapter;
  32. private isOpened;
  33. private animationFrame;
  34. private animationTimer;
  35. constructor(adapter?: Partial<MDCBannerAdapter>);
  36. destroy(): void;
  37. open(): void;
  38. /**
  39. * @param reason Why the banner was closed. Value will be passed to
  40. * events.CLOSING and events.CLOSED via the `event.detail.reason`
  41. * property. Standard values are CloseReason.PRIMARY and
  42. * CloseReason.SECONDARY, but CloseReason.UNSPECIFIED is provided for
  43. * custom handling of programmatic closing of the banner.
  44. */
  45. close(reason: CloseReason): void;
  46. isOpen(): boolean;
  47. handlePrimaryActionClick(disableAutoClose?: boolean): void;
  48. handleSecondaryActionClick(disableAutoClose?: boolean): void;
  49. layout(): void;
  50. private handleAnimationTimerEnd;
  51. }