Removes the custom close callback

Closes the overlay.

The result can be accessed in the overlay component as follows:

const overlayRef = this.overlayService.open(OverlayComponent);

overlayRef.onClose.subscribe((myString) => {
   console.log('[OverlayDemo] onClose Subscription: ', myString);
 });

Destroys the overlay.

This method is called by the OverlayService when the overlay is destroyed and does not need be called by the consumer.

Returns a reference to the component displayed in the overlay.

const componentRef: ConfirmationComponent = this.overlayRef?.getDisplayedComponentInstance<ConfirmationComponent>();

Hides the overlay.

This method is called by the OverlayService when the overlay is hidden behind another overlay and does not need be called by the consumer.

Registers a custom close callback.

The callback must return a promise that resolves to a boolean value.

Can be used to show the user a confirmation dialog before closing the overlay, e.g. if the form is invalid

If the promise resolves to true, the overlay will be closed. If the promise resolves to false, the overlay will not be closed.

overlayRef.registerCloseCallback(() => {
  return new Promise((resolve, _reject) => {
    resolve(true);
   }) as Promise<boolean>;
});

Reveals the overlay.

This method is called by the OverlayService when the overlay is revealed by closing the topmost overlay and does not need be called by the consumer.