JSPM – sweetalert2@4.1.0

Package Exports

sweetalert2
sweetalert2/dist/sweetalert2
sweetalert2/dist/sweetalert2.css
sweetalert2/dist/sweetalert2.js
sweetalert2/dist/sweetalert2.min.css
sweetalert2/dist/sweetalert2.min.js
sweetalert2/src/utils/dom

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sweetalert2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SweetAlert2

An awesome replacement for JavaScript's popup boxes.

What's the difference between SweetAlert and SweetAlert2?

Reason of creating this fork is inactivity of original SweetAlert plugin: http://stackoverflow.com/a/27842854/1331425 SweetAlert to SweetAlert2 migration guide

See SweetAlert2 in action!

Usage

To install:

bower install sweetalert2

Or:

npm install sweetalert2

Or download from CDN: https://www.jsdelivr.com/projects/sweetalert2

To use:

<script src="bower_components/sweetalert2/dist/sweetalert2.min.js"></script>
<link rel="stylesheet" type="text/css" href="bower_components/sweetalert2/dist/sweetalert2.min.css">

<!-- for IE support -->
<script src="bower_components/es6-promise/promise.min.js"></script>

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(function() {
  swal(
    'Deleted!',
    'Your imaginary file has been deleted.',
    'success'
  );
}, function(dismiss) {
  // dismiss can be 'cancel', 'overlay', 'close', 'timer'
  if (dismiss === 'cancel') {
    swal(
      'Cancelled',
      'Your imaginary file is safe :)',
      'error'
    );
  }
});

View more examples

`success`	`error`	`warning`	`info`	`question`

Configuration

Argument	Default value	Description
`title`	`null`	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.
`html`	`null`	A HTML description for the modal. If `text` and `html` parameters are provided in the same time, "text" will be used.
`type`	`null`	The type of the modal. SweetAlert2 comes with 5 built-in types which will show a corresponding icon animation: `warning`, `error`, `success`, `info` and `question`. It can either be put in the array under the key `type` or passed as the third parameter of the function.
`customClass`	`null`	A custom CSS class for the modal.
`animation`	`true`	If set to `false`, modal CSS animation will be disabled.
`allowOutsideClick`	`true`	If set to `false`, the user can't dismiss the modal by clicking outside it.
`allowEscapeKey`	`true`	If set to `false`, the user can't dismiss the modal by pressing the Escape key.
`showConfirmButton`	`true`	If set to `false`, a "Confirm"-button will not be shown. It can be useful when you're using `html` parameter for custom HTML description.
`showCancelButton`	`false`	If set to `true`, a "Cancel"-button will be shown, which the user can click on to dismiss the modal.
`confirmButtonText`	`"OK"`	Use this to change the text on the "Confirm"-button.
`cancelButtonText`	`"Cancel"`	Use this to change the text on the "Cancel"-button.
`confirmButtonColor`	`"#3085d6"`	Use this to change the background color of the "Confirm"-button (must be a HEX value).
`cancelButtonColor`	`"#aaa"`	Use this to change the background color of the "Cancel"-button (must be a HEX value).
`confirmButtonClass`	`null`	A custom CSS class for the "Confirm"-button.
`cancelButtonClass`	`null`	A custom CSS class for the "Cancel"-button.
`buttonsStyling`	`true`	Apply default swal2 styling to buttons. If you want to use your own classes (e.g. Bootstrap classes) set this parameter to `false`.
`reverseButtons`	`false`	Set to `true` if you want to invert default buttons positions.
`showCloseButton`	`false`	Set to `true` to show close button in top right corner of the modal.
`showLoaderOnConfirm`	`false`	Set to `true` to disable buttons and show that something is loading. Useful for AJAX requests.
`preConfirm`	`null`	Function to execute before confirm, should return Promise, see usage example.
`imageUrl`	`null`	Add a customized icon for the modal. Should contain a string with the path or URL to the image.
`imageWidth`	`null`	If imageUrl is set, you can specify imageWidth to describes image width in px.
`imageHeight`	`null`	Custom image height in px.
`imageClass`	`null`	A custom CSS class for the customized icon.
`timer`	`null`	Auto close timer of the modal. Set in ms (milliseconds).
`width`	`500`	Modal window width, including paddings (`box-sizing: border-box`).
`padding`	`20`	Modal window padding.
`background`	`"#fff"`	Modal window background (CSS `background` property).
`input`	`null`	Input field type, can be `"text"`, `"email"`, `"password"`, `"textarea"`, `"select"`, `"radio"`, `"checkbox"` and `"file"`.
`inputPlaceholder`	`""`	Input field placeholder.
`inputValue`	`""`	Input field initial value.
`inputOptions`	`{}` or `Promise`	If `input` parameter is set to `"select"` or `"radio"`, you can provide options. Object keys will represent options values, object values will represent options text values.
`inputAutoTrim`	`true`	Automatically remove whitespaces from both ends of a result string. Set this parameter to `false` to disable auto-trimming.
`inputValidator`	`null`	Validator for input field, should return Promise, see usage example.
`inputClass`	`null`	A custom CSS class for the input field.
`onOpen`	`null`	Function to run when modal opens, provides modal DOM element as the first argument.
`onClose`	`null`	Function to run when modal closes, provides modal DOM element as the first argument.
You can redefine default params by using `swal.setDefaults(customParams)` where `customParams` is an object.

Methods

Method	Description
`swal.setDefaults({Object})`	If you end up using a lot of the same settings when calling SweetAlert2, you can use setDefaults at the start of your program to set them once and for all!
`swal.resetDefaults()`	Resets settings to their default value.
`swal.queue([Array]
`swal.close()` or `swal.closeModal()`	Close the currently open SweetAlert2 modal programmatically.
`swal.enableButtons()`	Enable "Confirm" and "Cancel" buttons.
`swal.disableButtons()`	Disable "Confirm" and "Cancel" buttons.
`swal.enableConfirmButton()`	Enable the "Confirm"-button only.
`swal.disableConfirmButton()`	Disable the "Confirm"-button only.
`swal.enableLoading()` or `swal.showLoading()`	Disable buttons and show loader. This is useful with AJAX requests.
`swal.disableLoading()` or `swal.hideLoading()`	Enable buttons and hide loader.
`swal.clickConfirm()`	Click the "Confirm"-button programmatically.
`swal.clickCancel()`	Click the "Cancel"-button programmatically.
`swal.showValidationError(error)`	Show validation error message.
`swal.resetValidationError()`	Hide validation error message.
`swal.enableInput()`	Enable input, this method works with `input` parameter.
`swal.disableInput()`	Disable input.

Browser compatibility

SweetAlert2 works in most major browsers (yes, even IE). Some details:

IE: 10+, Promise polyfill should be included (see usage example).
Microsoft Edge: 12+
Safari: 4+
Firefox: 4+
Chrome 14+
Opera: 15+

Note that SweetAlert2 does not and will not provide support or functionality of any kind on IE9 and lower.

Contributing

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

Fork the plugin repository.
Make sure you have Node and NPM installed.
When in the SweetAlert2 directory, run the command npm install to install npm packages.
Start gulp watcher gulp watch to automatically build and minify the SCSS and JS-files.
Make sure that dist/* files aren't committed and create a pull request.

sweetalert2