README.md

A beautiful replacement for JavaScript's "alert"

Installation

$ npm install --save sweetalert

Usage

import swal from 'sweetalert'

swal("Hello world!")

Upgrading from 1.X

Many improvements and breaking changes have been introduced in the 2.0 release. Make sure you read the upgrade guide to avoid nasty suprises!

Guides

• Installation
• Getting started
• Advanced examples
• Upgrading from 1.X

Documentation

• Configuration
• Methods
• Theming

Examples

An error message:

swal("Oops!", "Something went wrong!", "error")

A warning message, with a function attached to the confirm message:

• Using promises:

swal({
  title: "Are you sure?",
  text: "Are you sure that you want to leave this page?",
  icon: "warning",
  dangerMode: true,
})
.then(willDelete => {
  if (willDelete) {
    swal("Deleted!", "Your imaginary file has been deleted!", "success");
  }
});

• Using async/await:

const willDelete = await swal({
  title: "Are you sure?",
  text: "Are you sure that you want to delete this file?",
  icon: "warning",
  dangerMode: true,
})

if (willDelete) {
  swal("Deleted!", "Your imaginary file has been deleted!", "success");
}

A prompt modal, where the user's input is logged:

• Using promises:

swal("Type something:", {
  content: "input",
})
.then((value) => {
  swal(`You typed: ${value}`);
})

• Using async/await:

const value = await swal("Type something:", {
  content: "input",
})

swal(`You typed: ${value}`);

In combination with Fetch:

• Using promises:

swal({
  text: 'Wanna log some information about Bulbasaur?',
  button: {
    text: "Search!",
    closeModal: false,
  },
})
.then(willSearch => {
  if (willSearch) {
    return fetch(`http://pokeapi.co/api/v2/pokemon/1`)
  }
})
.then(result => result.json())
.then(json => console.log(json))
.catch(err => {
  swal("Oops!", "Seems like we couldn't fetch the info", "error")
})

• Using async/await:

const willSearch = await swal({
  text: 'Wanna log some information about Bulbasaur?',
  button: {
    text: "Search!",
    closeModal: false,
  },
})

if (willSearch) {
  try {
    const result = await fetch(`http://pokeapi.co/api/v2/pokemon/1`)
    const json = await result.json()
    console.log(json)
  } catch (err) {
    swal("Oops!", "Seems like we couldn't fetch the info", "error")
  }
}

Contributing

If you're changing the core library:

1. Make changes in the src folder.
2. Preview changes by running npm run docs
3. Submit pull request

If you're changing the documentation:

1. Make changes in the docs-src folder.
2. Preview changes by running npm run docs
3. Run npm run builddocs to compile the changes to the docs folder
4. Submit pull request