A beautiful, responsive, highly customizable and accessible (WAI-ARIA) replacement for JavaScript's popup boxes. Zero dependencies.
JavaScript CSS HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github chore(readme): use promise-polyfill instead of core-js Mar 20, 2018
assets chore(docs): update SweetAlert2 gif (#876) Feb 21, 2018
src feat(getters): expose getPopup() getter method (#1060) Apr 19, 2018
test feat(getters): expose getPopup() getter method (#1060) Apr 19, 2018
utils fix(release): make release script locale-independent (#1027) Mar 20, 2018
.appveyor.yml Fix/require in node env (#998) Mar 7, 2018
.babelrc Fix/babel config (#1041) Mar 24, 2018
.editorconfig Better type declaration for inputAttributes (#467) Mar 14, 2017
.gitignore Feature/remove dist folder and add release script (#857) Jan 29, 2018
.sass-lint.yml chrore(linters): enable property-sort-order for sass-lint (#889) Feb 7, 2018
.travis.yml chore(travis): google-chrome: latest -> chrome: stable (#1029) Mar 20, 2018
DONATIONS.md Add Mustafa Khader to Donors list Apr 2, 2018
LICENSE Add gulp watch task, improved contribution section in README. Jan 19, 2015
README.md Update README.md Apr 7, 2018
bower.json chore(bower.json): update ignore section Mar 20, 2018
gulpfile.js feat(api): go object oriented or go home Mar 24, 2018
karma.conf.js fix(ci): increase retryLimit to 42 for cron builds (SauceLabs) (#1037) Mar 22, 2018
package.json 7.19.0 Apr 19, 2018
release.js fix(release-script): install npm deps before running npm tasks (#962) Feb 28, 2018
sweetalert2.d.ts feat(api): inputValue as a Promise (#1025) Mar 20, 2018
tslint.json Restore compatibility with old TypeScript versions and fix DismissRea… Feb 24, 2018
yarn.lock Fix/babel config (#1041) Mar 24, 2018

README.md

SweetAlert2


Build Status: Linux Build Status: Windows Version jsdelivr gzip size Support me on Patreon PayPal Donate Backers on Open Collective Sponsors on Open Collective

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


See SweetAlert2 in action ↗


👉 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: unpkg.com/sweetalert2 | jsdelivr.net/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@7.1.0/dist/promise.min.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')

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

Contributors

This project exists thanks to all the people who contribute.

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:

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 🏆

Backers

Thank you to all our backers! 🙏

Sponsors

If you support this project by becoming a sponsor, your logo will show up here with a link to your website.