Need help with ngx-sweetalert2?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

496 Stars 68 Forks MIT License 208 Commits 1 Opened issues


Declarative, reactive, and template-driven SweetAlert2 integration for Angular

Services available


Need anything else?

Contributors list



Official SweetAlert2 integration for Angular

npm version Build Status license

This is not a regular API wrapper for SweetAlert (which already works very well alone), it intends to provide Angular-esque utilities on top of it.

:point_right: Version 9 is out! To upgrade from v8.x, read the release notes!

:point_right: Before posting an issue, please check that the problem isn't on SweetAlert's side.

Quick start

Wiki recipes

:package: Installation & Usage

1) Install ngx-sweetalert2 and sweetalert2 via the npm registry:

npm install sweetalert2 @sweetalert2/ngx-sweetalert2

:arrowdoubleup: Always upgrade SweetAlert2 when you upgrade ngx-sweetalert2. The latter is statically linked with SweetAlert2's type definitions.

Angular and SweetAlert2 versions compatibility table (click to show)
Angular version Latest compatible version range Required SweetAlert2 version range
Angular 9 to 11 @sweetalert2/[email protected]^9.0.0 (current) [email protected]^10.8.0
Angular 8 @sweetalert2/[email protected]~7.3.0 (:warning: NOT ~7.4.0, broken AoT metadata) [email protected]^9.7.0
Angular 7 @sweetalert2/[email protected]^5.1.0 [email protected]^8.5.0
Angular 6 @sweetalert2/[email protected]^5.1.0 [email protected]^8.5.0
Angular 5 @sweetalert2/[email protected]^5.1.0 [email protected]^8.5.0
Angular 4 @toverux/[email protected]^3.4.0 [email protected]^7.15.1
Angular 2 Try Angular 4 versions requirements, or older versions like @toverux/ngsweetalert2 unknown

2) Import the module:

import { SweetAlert2Module } from '@sweetalert2/ngx-sweetalert2';

@NgModule({ //=> Basic usage (forRoot can also take options, see the wiki) imports: [SweetAlert2Module.forRoot()],

//=> In submodules only:
imports: [SweetAlert2Module],

//=> In submodules only, overriding options from your root module:
imports: [SweetAlert2Module.forChild({ /* options */ })]

}) export class AppModule { }

That's it! By default, SweetAlert2 will be lazy-loaded, only when needed, from your local dependency of

, using the
syntax under the hood.

:link: API


Add the

attribute to an element to show a simple modal when that element is clicked.

To define the modal contents, you can pass a

(provided by sweetalert2) object, or a simple array of strings, of format

[title: string, text: string (, icon: string)]

A simple dialog:

  Do it!

More advanced, with text input, confirmation, denial and dismissal handling:


export class MyComponent {
  public saveFile(fileName: string): void {
    // ... save file

public handleDenial(): void { // ... don't save file and quit }

public handleDismiss(dismissMethod: string): void { // dismissMethod can be 'cancel', 'overlay', 'close', and 'timer' // ... do something } }

The directive can also take a reference to a

component for more advanced use cases:

  Delete {{ }}


The library also provides a component, that can be useful for advanced use cases, or when you

has too many options.

The component also allows you to use Angular dynamic templates inside the SweetAlert (see the

directive for that).

Simple example:

With [swal]: Delete {{ }}

Or DIY: Delete {{ }}

You can access the dialog from your TypeScript code-behind like this:

class MyComponent {
  public readonly deleteSwal!: SwalComponent;

You can pass native SweetAlert2 options via the

input, just in the case you need that:

By the way: every "special" option, like

, that are not native options from SweetAlert2, are prefixed with

You can catch other modal lifecycle events than (confirm), (deny) or (cancel):

export class MyComponent { 
    public swalWillOpen(event: WillOpenEvent): void {
      // Most events (those using $event in the example above) will let you access the modal native DOM node, like this:



structural directive lets you use Angular dynamic templates inside SweetAlerts.

The name "portal" is inspired by React or Angular CDK portals. The directive will replace certain parts of the modal (aka. swal targets) with embedded Angular views.

This allows you to have data binding, change detection, and use every feature of the Angular template syntax you want, just like if the SweetAlert was a normal Angular component (it's not at all).

{{ elapsedSeconds }} seconds elapsed since the modal was opened.

Using a structural directives allows us to take your content as a template, instantiate it lazily when needed (i.e. when the modal is shown), and putting it in a native DOM element that is originally outside the scope of your Angular app.

In this example we set the main content of the modal, where the

property is usually rendered when SweetAlert2 is in charge. You can also target the title, the footer, or even the confirm button, and more!

You just have to change the target of the portal (

is the default target). First, inject this little service in your component:

import { SwalPortalTargets } from '@sweetalert2/ngx-sweetalert2';

export class MyComponent { public constructor(public readonly swalTargets: SwalPortalTargets) { } }

Then, set the appropriate target as the value of

, here using two portals, the first one targeting the modal's content (this is the default), and the other one targeting the confirm button text.

    Send ({{ secondsLeft }} seconds left)

We have the following targets:

, and

These targets are mostly provided by SweetAlert2 and made available in the right format for swal portals by this library, but you can also make your own if you need to (take inspiration from the original service source). Those are just variables containing a function that returns a modal DOM element, not magic. The magic is inside the directive ;)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.