A beautiful, responsive, highly customizable and accessible (WAI-ARIA) replacement for JavaScript's popup boxes. Zero dependencies.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(docs): Added instructions for glitch remix (#1329) Dec 8, 2018
assets chore(docs): Added instructions for glitch remix (#1329) Dec 8, 2018
src fix: do not throw warnings when inputValue is a promise (#1333) Dec 9, 2018
test fix: do not throw warnings when inputValue is a promise (#1333) Dec 9, 2018
tools chore(release): improve jsdelivr purge Oct 12, 2018
utils chore: remove event-stream package (#1305) Nov 26, 2018
.appveyor.yml chore(appveyor): bump node to 10 (current LTS) (#1297) Nov 16, 2018
.babelrc chore(dev-deps): upgrade to Babel 7 Sep 4, 2018
.editorconfig Better type declaration for inputAttributes (#467) Mar 14, 2017
.eslintignore chore(dev): add .eslintignore Jul 25, 2018
.eslintrc.js chore(eslint): add 'indent' rule Nov 8, 2018
.gitignore feat(dev): add integration with coveralls (#1176) Jul 24, 2018
.sass-lint.yml fix(direction): Support for CSS direction property (#1275) Nov 6, 2018
.travis.yml chore(travis): control the number of devDeps (#1313) Dec 6, 2018
BACKERS.md Create BACKERS.md May 3, 2018
CHANGELOG.md chore(release): 7.31.1 [skip ci] Dec 7, 2018
DONATIONS.md Add Ventsislav Radev to Supporters Oct 31, 2018
LICENSE Add gulp watch task, improved contribution section in README. Jan 19, 2015
README.md chore(README): move badges below the gif Dec 10, 2018
bower.json Add gverni to collaborators (#1292) Nov 14, 2018
gulpfile.js fix(build): use `.min.css` for `.all.js` to prevent the string concat… Oct 29, 2018
karma.conf.js chore(ci): use headless Firefox (#1316) Dec 1, 2018
package.json chore(release): 7.31.1 [skip ci] Dec 7, 2018
release.config.js fix(release): fix version in dist files (#1235) Sep 28, 2018
sweetalert2.d.ts feat(api): add .isTimerRunning() (#1330) Dec 8, 2018
tslint.json Restore compatibility with old TypeScript versions and fix DismissRea… Feb 24, 2018
yarn.lock chore: bump dev-deps to latest Dec 6, 2018

README.md

SweetAlert2

A beautiful, responsive, customizable, accessible (WAI-ARIA) replacement for JavaScript's popup boxes. Zero dependencies.


See SweetAlert2 in action ↗

Build Status: Linux Build Status: Windows Coverage Status Version semantic-release badge jsdelivr Support me on Patreon PayPal Donate


👉 Upgrading from v6.x to v7.x? Read the release notes!

👉 Migrating from SweetAlert? SweetAlert 1.x to SweetAlert2 migration guide


Installation

npm install --save sweetalert2

Or:

bower install --save sweetalert2

Or download from CDN: jsdelivr.com/package/npm/sweetalert2

Usage

<script src="sweetalert2/dist/sweetalert2.all.min.js"></script>

<!-- Include a polyfill for ES6 Promises (optional) for IE11, UC Browser and Android browser support -->
<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.js"></script>

You can also include the stylesheet separately if desired:

<script src="sweetalert2/dist/sweetalert2.min.js"></script>
<link rel="stylesheet" href="sweetalert2/dist/sweetalert2.min.css">

Or:

// ES6 Modules or TypeScript
import Swal from 'sweetalert2'

// CommonJS
const Swal = require('sweetalert2')

It's possible to import JS and CSS separately, e.g. if you need to customize styles:

import swal from 'sweetalert2/dist/sweetalert2.js'

import 'sweetalert2/src/sweetalert2.scss'

Please note that TypeScript is well-supported, so you don't have to install a third-party declaration file.

Examples

The most basic message:

Swal('Hello world!')

A message signaling an error:

Swal('Oops...', 'Something went wrong!', 'error')

Handling the result of SweetAlert2 modal:

Swal({
  title: 'Are you sure?',
  text: 'You will not be able to recover this imaginary file!',
  type: 'warning',
  showCancelButton: true,
  confirmButtonText: 'Yes, delete it!',
  cancelButtonText: 'No, keep it'
}).then((result) => {
  if (result.value) {
    Swal(
      'Deleted!',
      'Your imaginary file has been deleted.',
      'success'
    )
  // For more information about handling dismissals please visit
  // https://sweetalert2.github.io/#handling-dismissals
  } else if (result.dismiss === Swal.DismissReason.cancel) {
    Swal(
      'Cancelled',
      'Your imaginary file is safe :)',
      'error'
    )
  }
})

Go here to see the docs and more examples ↗

Browser compatibility

IE11* Edge Chrome Firefox Safari Opera Android Browser* UC Browser*
✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️

* ES6 Promise polyfill should be included, see usage example.

Note that SweetAlert2 does not and will not provide support or functionality of any kind on IE10 and lower.

Related projects

Related community projects

Collaborators

@zenflow @toverux @acupajoe @samturrell @birjolaxew @gverni

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the sweetalert2 repository and clone it locally.

  2. Make sure you have npm or yarn installed.

  3. When in the SweetAlert2 directory, run npm install or yarn install to install dependencies.

  4. To begin active development, run npm start or yarn start. This does several things for you:

Backers

SheetJS LLC Unique-P GmbH

Donations

Has SweetAlert2 helped you create an amazing application? You can show your support by making a donation in one of several ways:

Hall of Donators 🏆