@browninglogic/ng-modal
Version:
A simple, lightweight interface for creating layered modal dialogs in Angular 6+
44 lines (43 loc) • 1.92 kB
TypeScript
import { OnInit, OnDestroy } from '@angular/core';
import { ModalManagerService } from '../services/modal-manager.service';
export declare class ModalWindowComponent implements OnInit, OnDestroy {
modalManagerService: ModalManagerService;
/** Custom CSS class(es) to apply to the modal*/
modalClass: string;
/** Custom CSS class(es) to apply to the overlay*/
overlayClass: string;
/** Specifies whether the modal will close if the user clicks on the surrounding overlay */
closeOnOverlayClick: boolean;
/** Specifies whether to show the built-in close button */
showCloseButton: boolean;
/** Index of the modal on the global modal stack*/
private modalIndex;
/** Subscription to index change notifications from the modal manager service*/
private subIndexChanged;
/** Visibility flag for internal use*/
private _visible;
/** Reports the visibility status of the modal window*/
get visible(): boolean;
constructor(modalManagerService: ModalManagerService);
ngOnInit(): void;
ngOnDestroy(): void;
/**
* Updates the local copy of the index when necessary so that the
* corresponding z-index will be updated in the template.
* @param newIndex new index provided by the modal management service
*/
onIndexChanged(newIndex: number): void;
/** Provides the z-index to be used in the template for layering the modal */
get zIndex(): number;
/** Shows the modal and registers it with the modal manager */
show(): void;
/** Hides the modal and de-registers it with the modal manager */
hide(): void;
/**
* Handles the click event when a user clicks on the overlay.
* If the user clicked on the overlay and closeOnOverlayClick is enabled,
* then close the modal.
* @param event The mouse event provided by the browser
*/
onOverlayClicked(event: MouseEvent): void;
}