component.d.ts 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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 { Corner } from './constants';
  25. import { MDCMenuSurfaceFoundation } from './foundation';
  26. import { MDCMenuDistance } from './types';
  27. /** MDC Menu Surface Factory */
  28. export declare type MDCMenuSurfaceFactory = (el: HTMLElement, foundation?: MDCMenuSurfaceFoundation) => MDCMenuSurface;
  29. /** MDC Menu Surface */
  30. export declare class MDCMenuSurface extends MDCComponent<MDCMenuSurfaceFoundation> {
  31. static attachTo(root: HTMLElement): MDCMenuSurface;
  32. anchorElement: Element | null;
  33. private previousFocus?;
  34. private handleKeydown;
  35. private handleBodyClick;
  36. private registerBodyClickListener;
  37. private deregisterBodyClickListener;
  38. initialSyncWithDOM(): void;
  39. destroy(): void;
  40. isOpen(): boolean;
  41. open(): void;
  42. close(skipRestoreFocus?: boolean): void;
  43. set quickOpen(quickOpen: boolean);
  44. /**
  45. * Sets the foundation to use page offsets for a positioning when the menu is
  46. * hoisted to the body.
  47. */
  48. setIsHoisted(isHoisted: boolean): void;
  49. /** Sets the element that the menu-surface is anchored to. */
  50. setMenuSurfaceAnchorElement(element: Element): void;
  51. /** Sets the menu-surface to position: fixed. */
  52. setFixedPosition(isFixed: boolean): void;
  53. /**
  54. * Sets the absolute x/y position to position based on. Requires the menu to
  55. * be hoisted.
  56. */
  57. setAbsolutePosition(x: number, y: number): void;
  58. /**
  59. * @param corner Default anchor corner alignment of top-left surface corner.
  60. */
  61. setAnchorCorner(corner: Corner): void;
  62. setAnchorMargin(margin: Partial<MDCMenuDistance>): void;
  63. getDefaultFoundation(): MDCMenuSurfaceFoundation;
  64. }