wp_back/README.md at a10ce9018b1d9506fe33c9e63852daeeb278ec27

2024-05-20 15:37:46 +03:00

13 KiB

Raw Blame History

[= Become the 🏆 Ultimate Sponsor of SweetAlert2 and place your banner here (100K+ unique visitors per month) =]

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

See SweetAlert2 in action ↗

:shipit: The author of SweetAlert2 (@limonte) is looking for short-term to medium-term working contracts in front-end, preferably OSS.

👉 Upgrading from v9.x to v10.x? Read the release notes!
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!

👉 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@10"></script>

Usage

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

<!-- Include a polyfill for ES6 Promises (optional) for IE11 -->
<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')

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.value) {
    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

IE11*	Edge	Chrome	Firefox	Safari	Opera	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.

Themes (`sweetalert2-themes ↗`)

ngx-sweetalert2 - Angular 4+ integration
sweetalert2-react-content - React integration
sweetalert2-webpack-demo - webpack demo
sweetalert2-parcel-demo - overriding SCSS variables demo

avil13/vue-sweetalert2 - Vue.js wrapper
realrashid/sweet-alert - Laravel 5 Package
Basaingeal/Razor.SweetAlert2 - Blazor Wrapper
ElectronAlert - SweetAlert2 for Electron applications (main process)

Collaborators


@gverni	@zenflow	@toverux

Contributing

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

Fork the sweetalert2 repository and clone it locally.
Make sure you have npm or yarn installed.
When in the SweetAlert2 directory, run npm install or yarn install to install dependencies.
To begin active development, run npm start or yarn 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