# Sweet Alert

## A beautiful replacement for Javascript's "Alert"

### So... What does it do?

Here’s a comparison of a standard error message. The first one uses the built-in alert-function, while the second is using sweetAlert.

#### Normal alert

##### Code:

    alert("Oops... Something went wrong!");

#### Sweet Alert

##### Code:

    sweetAlert("Oops...", "Something went wrong!", "error");

Pretty cool huh? SweetAlert automatically centers itself on the page and looks great no matter if you're using a desktop computer, mobile or tablet. It's even highly customizeable, as you can see below!

### More examples

In these examples, we're using the shorthand function swal to call sweetAlert.

- A basic message

      swal("Here's a message!")

- A title with a text under

      swal("Here's a message!", "It's pretty, isn't it?")

- A success message!

      swal("Good job!", "You clicked the button!", "success")

- A warning message, with a function attached to the "Confirm"-button...

      swal({
        title: "Are you sure?",
        text: "You will not be able to recover this imaginary file!",
        type: "warning",
        showCancelButton: true,
        confirmButtonColor: "#DD6B55",
        confirmButtonText: "Yes, delete it!",
        closeOnConfirm: false
      },
      function(){
        swal("Deleted!", "Your imaginary file has been deleted.", "success");
      });

- ... and by passing a parameter, you can execute something else for "Cancel".

      swal({
        title: "Are you sure?",
        text: "You will not be able to recover this imaginary file!",
        type: "warning",
        showCancelButton: true,
        confirmButtonColor: "#DD6B55",
        confirmButtonText: "Yes, delete it!",
        cancelButtonText: "No, cancel plx!",
        closeOnConfirm: false,
        closeOnCancel: false
      },
      function(isConfirm){
        if (isConfirm) {
          swal("Deleted!", "Your imaginary file has been deleted.", "success");
        } else {
      	    swal("Cancelled", "Your imaginary file is safe :)", "error");
        }
      });

- A message with a custom icon

      swal({
        title: "Sweet!",
        text: "Here's a custom image.",
        imageUrl: "images/thumbs-up.jpg"
      });

- An HTML message

      swal({
        title: "HTML <small>Title</small>!",
        text: "A custom <span style="color:#F8BB86">html<span> message.",
        html: true
      });

- A message with auto close timer

      swal({
        title: "Auto close alert!",
        text: "I will close in 2 seconds.",
        timer: 2000,
        showConfirmButton: false
      });

### Download & install

Method 1: Install through bower:

    $ bower install sweetalert

Method 2: Download the sweetAlert CSS and JavaScript files.

Download files

1. Initialize the plugin by referencing the necessary files:

       <script src="lib/sweet-alert.min.js"></script>
       <link rel="stylesheet" type="text/css" href="lib/sweet-alert.css">

2. Call the sweetAlert-function after the page has loaded

       swal({
         title: "Error!",
         text: "Here's my error message!",
         type: "error",
         confirmButtonText: "Cool"
       });

### Configuration

Here are the keys that you can use if you pass an object into sweetAlert:

Argument | Default value | Description
--- | --- | ---
title | null (required) | The title of the modal. It can either be added to the object under the key "title" or passed as the first parameter of the function.
text | null | A description for the modal. It can either be added to the object under the key "text" or passed as the second parameter of the function.
type | null | The type of the modal. SweetAlert comes with 4 built-in types which will show a corresponding icon animation: "warning", "error", "success" and "info". It can either be put in the array under the key "type" or passed as the third parameter of the function.
allowEscapeKey | true | If set to true, the user can dismiss the modal by pressing the Escape key.
customClass | null | A custom CSS class for the modal. It can be added to the object under the key "customClass".
allowOutsideClick | false | If set to true, the user can dismiss the modal by clicking outside it.
showCancelButton | false | If set to true, a "Cancel"-button will be shown, which the user can click on to dismiss the modal.
showConfirmButton | true | If set to false, the "OK/Confirm"-button will be hidden. Make sure you set a timer or set allowOutsideClick to true when using this, in order not to annoy the user.
confirmButtonText | "OK" | Use this to change the text on the "Confirm"-button. If showCancelButton is set as true, the confirm button will automatically show "Confirm" instead of "OK".
confirmButtonColor | "#AEDEF4" | Use this to change the background color of the "Confirm"-button (must be a HEX value).
cancelButtonText | "Cancel" | Use this to change the text on the "Cancel"-button.
closeOnConfirm | true | Set to false if you want the modal to stay open even if the user presses the "Confirm"-button. This is especially useful if the function attached to the "Confirm"-button is another SweetAlert.
imageUrl | null | Add a customized icon for the modal. Should contain a string with the path to the image.
imageSize | "80x80" | If imageUrl is set, you can specify imageSize to describes how big you want the icon to be in px. Pass in a string with two values separated by an "x". The first value is the width, the second is the height.
timer | null | Auto close timer of the modal. Set in ms (milliseconds).
html | false | If set to true, will not escape title and text parameters. (Set to false if you're worried about XSS attacks.)
animation | true | If set to false, the modal's animation will be disabled.

### Methods

SweetAlert also comes with some simple methods that you can call:

Function | Example | Description
--- | --- | ---
setDefaults | swal.setDefaults({ confirmButtonColor: '#0000' }); | If you end up using a lot of the same settings when calling SweetAlert, you can use setDefaults at the start of your program to set them once and for all!
close | swal.close(); | Close the currently open SweetAlert programatically.

### Contribute

SweetAlert was created by Tristan Edwards, you can follow him on Twitter or Dribbble for updates and other cool projects!

Feel free to fork sweetAlert on GitHub if you have any features that you want to add!