overlay.d.ts 720 B

123456789101112131415161718192021
  1. export interface ControllerShape<Opts, HTMLElm> {
  2. create(options: Opts): Promise<HTMLElm>;
  3. dismiss(data?: any, role?: string, id?: string): Promise<boolean>;
  4. getTop(): Promise<HTMLElm | undefined>;
  5. }
  6. export declare class OverlayBaseController<Opts, Overlay> implements ControllerShape<Opts, Overlay> {
  7. private ctrl;
  8. constructor(ctrl: ControllerShape<Opts, Overlay>);
  9. /**
  10. * Creates a new overlay
  11. */
  12. create(opts?: Opts): Promise<Overlay>;
  13. /**
  14. * When `id` is not provided, it dismisses the top overlay.
  15. */
  16. dismiss(data?: any, role?: string, id?: string): Promise<boolean>;
  17. /**
  18. * Returns the top overlay.
  19. */
  20. getTop(): Promise<Overlay | undefined>;
  21. }