@readwise/sweetalert2
v11.2.0-rc.2
Published
A beautiful, responsive, customizable and accessible (WAI-ARIA) replacement for JavaScript's popup boxes, supported fork of sweetalert
Downloads
5
Readme
:moneybag: Get $100 in free credits with DigitalOcean!
:point_right: Upgrading from v10.x to v11.x? Read the release notes! If you're upgrading from v9.x, please upgrade from v9 to v10 first! If you're upgrading from v8.x, please upgrade from v8 to v9 first! If you're upgrading from v7.x, please upgrade from v7 to v8 first! If you're upgrading from v6.x, please upgrade from v6 to v7 first!
:point_right: Migrating from SweetAlert? SweetAlert 1.x to SweetAlert2 migration guide
Installation
npm install --save sweetalert2
Or grab from jsdelivr CDN :
<script src="https://cdn.jsdelivr.net/npm/sweetalert2@11"></script>
Usage
<script src="sweetalert2/dist/sweetalert2.all.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')
Or with JS modules:
<link rel="stylesheet" href="sweetalert2/dist/sweetalert2.css">
<script type="module">
import Swal from 'sweetalert2/src/sweetalert2.js'
</script>
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.fire('Hello world!')
A message signaling an error:
Swal.fire('Oops...', 'Something went wrong!', 'error')
Handling the result of SweetAlert2 modal:
Swal.fire({
title: 'Are you sure?',
text: 'You will not be able to recover this imaginary file!',
icon: 'warning',
showCancelButton: true,
confirmButtonText: 'Yes, delete it!',
cancelButtonText: 'No, keep it'
}).then((result) => {
if (result.isConfirmed) {
Swal.fire(
'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.fire(
'Cancelled',
'Your imaginary file is safe :)',
'error'
)
}
})
Go here to see the docs and more examples ↗
Browser compatibility
Chrome | Firefox | Safari | Edge -------|---------|--------|----- :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:
If you need IE11 and legacy Edge support, please use the previous major version.
Themes (sweetalert2-themes ↗
)
Related projects
- ngx-sweetalert2 - Angular 4+ integration
- sweetalert2-react-content - React integration
- sweetalert2-webpack-demo - webpack demo
- sweetalert2-parcel-demo - overriding SCSS variables demo
Related community projects
- avil13/vue-sweetalert2 - Vue.js wrapper
- realrashid/sweet-alert - Laravel 5 Package
- Basaingeal/Razor.SweetAlert2 - Blazor Wrapper
- ElectronAlert - SweetAlert2 for Electron applications (main process)
Contributing
If you would like to contribute enhancements or fixes, please do the following:
Fork the
sweetalert2
repository and clone it locally.When in the SweetAlert2 directory, run
npm install
oryarn install
to install dependencies.To begin active development, run
npm start
oryarn start
. This does several things for you:
- Builds the
dist
folder - Serves sandbox.html @ http://localhost:8080/ (browser-sync ui: http://localhost:8081/)
- Re-builds and re-loads as necessary when files change
- To run tests, run
npm run cypress:open
oryarn cypress:open
Big Thanks
- FlowCrypt for continuous support of this project
- Serena Verni (@serenaperora) for creating the amazing project logo
Sponsors
For all questions related to sponsorship please contact me via email [email protected]
| | | | | -|-|-|-|-|- Become a sponsor | FlowCrypt | life digital | Code Rubik | NDCHost | Bitvape
| | -|-|- Halvin Laina | Tiago de Oliveira Stutz | SebaEBC
NSFW Sponsors
| | | | -|-|-|-|- Sex Toy WoW | Fresh Materials | Joy Love Dolls | STED | My Sex Toy Guide
| | -|-|- Best Blowjob Machines | STC | DoctorClimax
Support and Donations
Has SweetAlert2 helped you create an amazing application? You can show your support via GitHub Sponsors
Alternative ways for donations (PayPal, cryptocurrencies, etc.) are listed here: https://sweetalert2.github.io/#donations