Angular popup module


001.1.03 years ago3 years agoMinified + gzip package size for @clementvh/angular-popup in KB




An angular module to display popup on screen, supported by angular >= 4.0.0


$ npm install @clementvh/angular-popup

Basic Usage

Add PopupModule and your component in your angular root module :

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { PopupModule } from '@clementvh/angular-popup';

import { AppComponent } from './app.component';

  imports: [
  declarations: [
  entryComponents: [MyComponent],
  bootstrap: [AppComponent]
export class AppModule { }

Insert the popup component into your root component


<h1>App Component</h1>

Inject the PopupService into a component :

import { Component } from '@angular/core';
import { PopupService } from '@clementvh/angular-popup';

  selector: 'app-root',
  templateUrl: './app.component.html'
export class AppComponent {
  constructor(public popupService: PopupService) {}

Call service methods to open a popup :

this.popupService.openHtml(MyComponent, {
  id: 'toto-popup'

PopupService's available methods


Open a popup with the given component inside

 * @param {Type<any>} component The component to instatiate in the popup.
 * @param {Object} options Options given to the popup.
openHtml(component: Type<any>, options: any = {}): void;


Open a popup confirm with the given title and text and two buttons at the bottom 'Cancel' and 'Confirm'

 * @param {string} title The popup's title.
 * @param {string} text The popup(s content text.
 * @param {Object} options Options given to the popup.
openConfirm(title: string, text: string, options: any = {}): void;


Open a popup with an iframe to the given url

 * @param {string} url The url for the iframe
 * @param {Object} options Options given to the popup.
openIframe(url: string, options: any = {}): void;


Options object should be a type of PopupOptions interface. The object may have following properties:

  • id - {string} - CSS class injected on the .app-popup-container block.
  • dismissable - {boolean} - if false clicking outside the popup won't close it.
  • showClose - {boolean} - if false the close icon won't be displayed.
  • confirm - {Function} - Function to call when confirm button is clicked.
  • cancel - {Function} - Function to call when cancel button is clicked.
  • confirmText - {string} - Text to inject in confirm button.
  • cancelText - {string} - Text to inject in cancel button.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.