Simple alert(), confirm(), prompt() for Vue.js, using sweetalert2.
npm install vue-simple-alert
Simple _alert()_, _confirm()_, _prompt()_ for Vue.js, using sweetalert2.
Check out live
demo
- Provides simple _alert()_, _confirm()_, _prompt()_ like DOM Window methods.
- Based on sweetalert2.
- Installed as a Vue.js plugin.
- Promise based API.
- Support typescript.
``bash`
npm i vue-simple-alert
`javascript
// main.js
import Vue from "vue";
import VueSimpleAlert from "vue-simple-alert";
Vue.use(VueSimpleAlert);
`
`javascript
// in any component
this.$alert("Hello Vue Simple Alert.");
`
`javascript
// in any component
this.$confirm("Are you sure?").then(() => {
//do something...
});
`
`javascript
// in any component
this.$prompt("Input your name").then(text => {
// do somthing with text
});
`
Global options can be set when initialize plugin. Refer to sweetalert2 documentation
`javascript
// main.js
import Vue from "vue";
import VueSimpleAlert from "vue-simple-alert";
Vue.use(VueSimpleAlert, { reverseButtons: true });
`
You can use sweetalert2's _fire()_ method through _\$fire()_.
For detailed usage, refer to sweetalert2 documentation.
`javascript
// in any component
this.$fire({
title: "Title",
text: "text",
type: "success",
timer: 3000
}).then(r => {
console.log(r.value);
});
``
The _alert()_ method displays an alert box with a specified message and an OK button.
- message: string
> Optional. Specifies the text to display in the alert box
- title: string
> Optional. Specifies title of the alert box
- type: 'success' | 'error' | 'warning' | 'info' | 'question'
> Optional. Specifies icon type.
- options: SweetAlertOptions
> Optional. Advanced options. Refer to sweetalert2 documentation.
- returns: Promise\
> Will be resolved with true when alert box closed.
The confirm() method displays a dialog box with a specified message, along with an OK and a Cancel button.
- message: string
> Optional. Specifies the text to display in the confirm box
- title: string
> Optional. Specifies title of the confirm box
- type: 'success' | 'error' | 'warning' | 'info' | 'question'
> Optional. Specifies icon type.
- options: SweetAlertOptions
> Optional. Advanced options. Refer to sweetalert2 documentation.
- returns: Promise\
> Will be resolved when OK button clicked. If confirm box closed by any other reason, this promise will be rejected.
The prompt() method displays a dialog box that prompts the user for input.
- message: string
> Required. Specifies the text to display in the dialog box
- defaultText: string
> Optional. The default input text
- title: string
> Optional. Specifies title of the confirm box
- type: 'success' | 'error' | 'warning' | 'info' | 'question'
> Optional. Specifies icon type.
- options: SweetAlertOptions
> Optional. Advanced options. Refer to sweetalert2 documentation.
- returns: Promise\
> Will be resolved with input text when OK button clicked. If the user clicks OK without entering any text, promise will be resolved with an empty string. If dialog box closed by any other reason, this promise will be rejected.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE file for details