Skip to main content

An OverView On VueJS Alert plugin vue-sweetalert2


In this article, we are going to explore the 'sweetalert2' plugin by integrating into a sample VueJs application.

Create A Sample Vue App:

Let's run the following commands to create a sample Vue app.


Command To Install Vue CLI Globally On Your System:

npm run -g @vue/cli
Command To Create Vue App:

vue create your_application_name
After creating a sample application run the following command to start the application.
Command To Run Vue App:

npm run serve

Install vue-sweetalert2:

Run the following command to install our plugin.
Command To Install Alert Plugin:

npm install -s vue-sweetalert2
After successfully installing the plugin cross-verify it's presence in the package.json file.

Register SweetAlert2 In main.js:

On registering SweetAlert2 in main.js, then it will be available to all components of the application.
src/main.js:
import Vue from 'vue'
import App from './App.vue';
import VueSweetalert2  from 'vue-sweetalert2';

import 'sweetalert2/dist/sweetalert2.min.css';

Vue.config.productionTip = false

Vue.use(VueSweetalert2)

new Vue({
  render: h => h(App),
}).$mount('#app')
  • (Line: 3) 'VueSweetalert2' loading from 'vue-sweetalert2' plugin
  • (Line: 5) loading 'vue-sweetalert2' plugin CSS file. It is an optional link to load. If we want we can write our own custom CSS.
  • (Line: 9) 'VueSweetalert2' injected or registered to 'Vue' instance. By doing the 'VueSweetalert2' will available to all the components of the application and can be accessed with 'this' scope as 'this.$swal()'.

SweetAlert2 fire Method:

We know that we can get 'VueSweetalert2' instance with 'this' scope in the components. 'this.$swal.fire()' here 'fire' method will open up the alert. The 'fire' method will available to us in 3 overloaded methods approach.
// with single input string parameter

this.$swal.fire('Hello');

// with multiple input string parameter

this.$swal.fire('Iam title', 'Hello','success')

// with js object literal as confugration input
this.$swal.fire({text:'Hello'})
Let's begin by configuring a simple alert box a follow.
src/components/Helloworld.vue:
<template>
    <button @click="showAlert">Show Alert</button>
</template>

<script>
export default {
  methods:{
    showAlert(){
      this.$swal.fire('Hello Vue');
    }
  }
}
</script>

Text And Html Properties:

The 'fire' overloaded method that takes an object literal as the input parameter is the most preferred method to get more control on the alert box.

Text property caries the description for the alert.
src/components/Helloworld.vue:
showAlert(){
  this.$swal.fire({
	text:"Hello i'm text prop"
  });
}


Html property also caries the description to alert. Here we can give HTML as input for the Html property. If our alert contains both HTML and text property, then text property will override the Html property value.
this.$swal.fire({
 html:"<h1>Hello i'm html prop</h2>"
});

Title And Footer Properties:

The 'title' property to define the title information on the alert modal. This 'title' caries data like either text or HTML.

The 'footer' property to define the footer information on the alert modal. This 'footer' caries data like either text or HTML.
src/components/Helloworld.vue:
this.$swal.fire({
 title:"<h4>Hello I'm Title Prop</h4>",
 footer:"Hello I'm Footer Prop"
});

Icon Property:

The 'icon' property makes an alert property more understandable by visualizing it. The following are the keywords of icons provided by 'SweetAlert2':
  • success
  • error
  • warning
  • info
  • question
src/components/HelloWorld.vue:
showAlert(){
  this.$swal.fire({
	icon:'success',
	text:"I'm displaying success icon"
  });
}


Buttons:

The 'SweetAlert2' provides us 2 different types of buttons, those all are configurable very easily. The following are configurable properties of the alert for the buttons:
  • showConfirmButton
  • showCancelButton
  • confirmButtonText
  • cancelButtonText
src/components/HelloWorld.vue:
showAlert(){
  this.$swal.fire({
	text:"Im buttons popup",
	showConfirmButton:true,
	showCancelButton:true,
	confirmButtonText:'Save',
	cancelButtonText: 'Close'
  });
}
The 'fire' method returns a promise. The 'ConfirmButton', 'CancelButton' returns the boolean status to the 'fire' method promise like 'isConfirmed', 'isDismissed'.
showAlert(){
  this.$swal.fire({
	text:"Im buttons popup",
	showConfirmButton:true,
	showCancelButton:true,
	confirmButtonText:'Save',
	cancelButtonText: 'Close'
  }).then((result) => {
	if(result.isConfirmed){
	   this.$swal.fire('Hurray you clicked confirm button');
	}else if(result.isDismissed){
	  this.$swal.fire('ohhh you clicked cancel button');
	}
  });
}
  • (Line: 8) after clicking the buttons 'fire' method promise get invoked
  • (Line: 9&11) status of the button clicked type like 'isConfirmed' and 'isDismissed'
  • (Line: 10&12) invoking the nested alerts.

Alert With Images:

The 'SweetAlert2' gives the flexibility to configure the images on the alert modal. The image configuration props like 'imageUrl', 'imageAlt', 'imageHeight', 'imageWidth', etc.
src/components/HelloWorld.vue:
showAlert(){
  this.$swal.fire({
	imageUrl:"your image url",
	imageHeight:200,
	imageWidth:200,
	imageAlt:'no image'
  });
}

Timer:

We can set the 'timer' property that accepts milliseconds as value to automatically close alert after the specified time.
src/components/HelloWorld.vue:
this.$swal.fire({
	text:'I can close automatically by using timer in milli seconds',
	timer:3000
});

Position:

Using the 'position' property we can set the position of the alert modal to display on the window. Position keywords are like: 'top', 'top-start', 'top-end', 'center', 'center-start', 'center-end', 'bottom', 'bottom-start', 'bottom-end'.
src/components/HelloWorld.vue:
this.$swal.fire({
	text:'i will appear bottom right most corner',
	position:'bottom-end'
});

Input Types:

The alert form also supports input type fields like 'text', 'email', 'URL', 'select' etc. The alert modal supports only one field. If you want multiple fields it better prefers direct modal popups instead of an alert box. But through adding custom HTML you can add multiple fields but it is not recommended. Some configuration properties like 'input', 'inputValue', 'inputValidator', etc.
src/component/HelloWorld.vue:
showAlert(){
  this.$swal.fire({
	text:'Text box with validation',
	input:'text',
	inputValue:"Hello i'm initial value",
	inputValidator:(value) => {
	  if(!value){
		return "text field can't be null";
	  }
	}
  });
}
  • (Line: 4) 'input' property to define the input type,
  • (Line: 5) 'inputValue' is to carry the default value for the input type of 'text' field on the initial rendering of the alert.
  • (Line: 6) 'inputValidator' for filed validation.

PreConfirm Handler:

The 'preConfirm' handler executes the before confirming button returns to the 'fire' method promise. This 'preConfirm' handlers are used to call ajax to fetch the data on clicking the confirm button. The result returned from the 'preConfirm' method will be accessed in this 'fire' method promise as 'value' property.
sr/components/HelloWorld.vue:
showAlert(){
  this.$swal.fire({
	text:'Text box with validation',
	input:'text',
	preConfirm:(textValue) => {
	  return textValue
	}
  }).then((result) => {
	if(result.isConfirmed){
	  this.$swal.fire(result.value);
	}
  });
}
  • (Line: 5) 'preConfirm' handler triggered by the 'confirm' button. In a real-time application here we are going to call ajax request and return the payload to alert promise.
Here we have discussed a few basic configurations and the most widely used conjugations of alert modal from SweetAlert2. There are many more features that are provided by it you can explore from the official docs "https://sweetalert2.github.io/".

Wrapping Up:

Hopefully, I think this article delivered some useful information on SweetAlert2 library in VueJs application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route.

An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below
app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaults:new { …

GraphQL API Integration In Asp.Net Core Application

Introduction:
GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data.
How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions.HTTP-POST is the only Http verb recommended by the GraphQL.The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API:The main building blocks of GraphQL API is Schemas and Types. A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc.Types likely to be called Grap…

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API.
When To Use Versioning:Any API response changes.Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production.Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types:Query String VersioningUrl Path VersioningMedia Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.
 Install-Package Microsoft.AspNetCore.Mvc.Versioning -version 4.0.0 Register API V…

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload:The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client. Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file. Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk. If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application.
Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.  Check the link to use the Visual Studio Code for .NET Core Application.
IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files from the client, then the entire …

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items.
The main building block of ion-picker as follows: PickerControllerPickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options
PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker.
Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger", "Lion", "Elephant"…

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library jQuery Validate.
In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples.
Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio.
Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as below.
PersonController.cs: us…

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form.
Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor. Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production.
Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component, name it as "UserForm.razor"
Add Route: In Blazor routing can be configured using @page  directive, and URL should b…

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism:Blazor Server is a very light-weight web development framework. In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation. Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server. Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required information or changed …

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.
Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command
npm i -g @nestjs/cli Now create a sample project by using Nest CLI command  nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".
"dependencies" contains all plugins to be installed and used them to run the application.
"devDependencies" contain all plugins to be installed and used them at the time of application development.
"scrip…

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server.
Main Response Caching Headers are like below
Cache-ControlPragmaVary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response.private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores.max-age - this directive represents a time to hold a response in the cache.no-cache - this directive represents no storing of response and always fetch the fresh response from serverno-store…