constants.d.ts 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 { FocusOptions, FocusTrap } from '@material/dom/focus-trap';
  24. /** Banner element classes. */
  25. export declare const cssClasses: {
  26. CLOSING: string;
  27. OPEN: string;
  28. OPENING: string;
  29. };
  30. /** Banner numbers. */
  31. export declare const numbers: {
  32. BANNER_ANIMATION_CLOSE_TIME_MS: number;
  33. BANNER_ANIMATION_OPEN_TIME_MS: number;
  34. };
  35. /** Banner events. */
  36. export declare const events: {
  37. CLOSED: string;
  38. CLOSING: string;
  39. OPENED: string;
  40. OPENING: string;
  41. ACTION_CLICKED: string;
  42. };
  43. /** Banner selectors. */
  44. export declare const selectors: {
  45. CONTENT: string;
  46. PRIMARY_ACTION: string;
  47. SECONDARY_ACTION: string;
  48. TEXT: string;
  49. };
  50. /** Reason as to why the banner was closed. */
  51. export declare enum CloseReason {
  52. PRIMARY = 0,
  53. SECONDARY = 1,
  54. UNSPECIFIED = 2
  55. }
  56. /**
  57. * Payload of actionClicked events to signify which action emitted the event.
  58. */
  59. export declare enum Action {
  60. PRIMARY = 0,
  61. SECONDARY = 1,
  62. UNKNOWN = 2
  63. }
  64. /** Interface for the detail of the closing and closed events emitted. */
  65. export interface MDCBannerCloseEventDetail {
  66. reason: CloseReason;
  67. }
  68. /** Interface for the detail of the closing and closed events emitted. */
  69. export interface MDCBannerActionEventDetail {
  70. action: Action;
  71. }
  72. /** */
  73. export declare type MDCBannerFocusTrapFactory = (element: HTMLElement, options: FocusOptions) => FocusTrap;