component.d.ts 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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. import { MDCComponent } from '@material/base/component';
  24. import { MDCSnackbarFoundation } from './foundation';
  25. import { MDCSnackbarAnnouncerFactory } from './types';
  26. /** MDC Snackbar */
  27. export declare class MDCSnackbar extends MDCComponent<MDCSnackbarFoundation> {
  28. static attachTo(root: HTMLElement): MDCSnackbar;
  29. private announce;
  30. private actionEl;
  31. private labelEl;
  32. private surfaceEl;
  33. private handleKeyDown;
  34. private handleSurfaceClick;
  35. initialize(announcerFactory?: MDCSnackbarAnnouncerFactory): void;
  36. initialSyncWithDOM(): void;
  37. destroy(): void;
  38. open(): void;
  39. /**
  40. * @param reason Why the snackbar was closed. Value will be passed to
  41. * CLOSING_EVENT and CLOSED_EVENT via the `event.detail.reason` property.
  42. * Standard values are REASON_ACTION and REASON_DISMISS, but custom
  43. * client-specific values may also be used if desired.
  44. */
  45. close(reason?: string): void;
  46. getDefaultFoundation(): MDCSnackbarFoundation;
  47. get timeoutMs(): number;
  48. set timeoutMs(timeoutMs: number);
  49. get closeOnEscape(): boolean;
  50. set closeOnEscape(closeOnEscape: boolean);
  51. get isOpen(): boolean;
  52. get labelText(): string;
  53. set labelText(labelText: string);
  54. get actionButtonText(): string;
  55. set actionButtonText(actionButtonText: string);
  56. private registerKeyDownHandler;
  57. private deregisterKeyDownHandler;
  58. private registerSurfaceClickHandler;
  59. private deregisterSurfaceClickHandler;
  60. private isActionButton;
  61. private isActionIcon;
  62. }