Skip to main content

VueJS Modal Popup Integration Using @kouts/vue-modal Plugin

In this article, we are going to explore the implementation of modal popup using '@kouts/vue-modal' plugin in the VueJS application.

Overview On @kouts/vue-modal Plugin:

Some key features of this plugin are as below:
  • LightWeight, the minified gzipped version is < 8kb
  • Opens and closes with a data variable using v-model
  • Includes sensible default styling but it's also highly customizable via user CSS classes and styles
  • Override modal title and content via slots
  • Modal intro and outro effects using CSS animation classes
  • Exposes Component events like before-open, opening, after-open, before-close, after-close
  • Scrollable when it's contents exceed screen height.
  • Closeable by clicking on the upper right "x", the overlay, or the ESC key.
  • Stackable - Multiple modal windows on top of each other.
  • Ability to set initialFocus on an element when the modal window opens just set the autofocus attribute on an element inside the modal.
  • Focus management traps keyboard focus - tabbed navigation inside the modal window.
  • Ability to have unclosable modal windows.
  • Render on-demand or stay always in DOM with "live" mode.
  • Modals append to <body> by default, ability to append to the custom element.

Create A VueJS Sample 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 @kouts/vue-modal Npm Package:

Command To Install Modal Popup:
npm i @kouts/vue-modal --save
After installing the package successfully reference of the package will be added to the package.json.

Configure Plugin Globally:

As a first step, we need to import the plugin and configure it with vue instance to make it global(plugin modal component will available throughout the application) use main.js(entry file).
src/main.js:
import Vue from 'vue'
import App from './App.vue'
import VueModal from '@kouts/vue-modal'
import '@kouts/vue-modal/dist/vue-modal.css'

Vue.component('Modal', VueModal)

Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')
  • (Line: 3) Loads the '@kouts/vue-modal' plugin.
  • (Line: 4) Loads styles of the modal popup plugin.
  • (Line: 6) Integrating the 'VueModal' component instance to the Vue instance globally this makes modal popup available all over the application.

Open Modal Popup:

The 'VueModal' component popup opening and closing is so simple integration like assigning a boolean value to the 'v-model'.
src/components/HelloWorld.vue:
<template>
  <div>
    <button type="button" class="btn btn-primary" @click="showModal=true" >Open a modal</button>
     <Modal v-model="showModal">
      <p>Modal content goes here...</p>
    </Modal>
  </div>
</template>

<script>
export default {
  name: "HelloWorld",
  data() {
    return {
      showModal: false
    };
  }
};
</script>
  • (Line: 3) Button to open the modal popup. Click event assigned to 'showModal' property as true.
  • (Line: 4) 'Modal' component set with 'v-model' by assigning the boolean property. This 'v-model' core part to open and closing of the modal popup. If 'v-model' set true opens the popup if 'v-model' set false close the popup.
  • (Line: 15) The 'showModal' boolean property declared as vue component data property.

Title Property Of Modal Popup:

The configurable title property of the modal popup.
src/components/HelloWorld.vue:(Html Part)
<Modal v-model="showModal" :title="modalTitle">
  <p>Modal content goes here...</p>
</Modal>
src/components/HelloWorld.vue:(Script Part):
data() {
 return {
  showModal: false,
  modalTitle:'Welcome Tech Seeker'
 };
}

Stackable Modals:

This modal plugin supports the opening of multiple or stackable modal popups.
src/components/HelloWorld.vue:(Html Part)
<template>
  <div>
    <button type="button" class="btn btn-primary" @click="showModal=true" >Open a modal</button>
     <Modal v-model="showModal" :title="modalTitle">
      <p>Modal content goes here...</p>
      <p>Modal content goes here...</p>
      <p>Modal content goes here...</p>
      <p>Modal content goes here...</p>
      <button type="button" class="btn btn-primary" @click="showSecondModal=true">Open 2nd window</button>
    </Modal>
     <Modal v-model="showSecondModal" title="Stackable Model">
      <p>Hi I'm second Modal</p>
    </Modal>
  </div>
</template>
  • (Line: 9) On first modal popup added a button to which click event assigned a boolean property 'showSecondModal' to show 2nd modal popup on top of the 1st modal popup.
  • (Line: 11) The 2nd modal popup declared by using the 'showSecondModal' boolean property as value to 'v-model'.
src/components/HelloWorld.vue:(Script Part)
data() {
 return {
  showModal: false,
  showSecondModal:false,
  modalTitle:'Welcome Tech Seeker'
 };
}

Modal Events:

The events supported by this plugin modal popup are:
  • before-open
  • after-open
  • before-close
  • after-close
src/components/HelloWorld.vue:(Html Part)
<Modal v-model="showModal" 
 :title="modalTitle"
 @before-open="beforeOpen"
 @before-close="beforeClose"
 @after-open="afterOpen"
 @after-close="afterClose">
  <p>Modal content goes here...</p>
</Modal>
src/components/HelloWorld.vue(Script Part):
methods:{
 beforeOpen(){
  alert("hi i'm before open");
 },
 beforeClose(){
  alert("hi i'm before close");
 },
 afterOpen(){
  alert("hi i'm after open");
 },
 afterClose(){
  alert("hi i'm after close");
 }
}
That's all about modal popup integration using '@kouts/vue-modal' plugin. To learn more options about this plugin visit "https://github.com/kouts/vue-modal".

Wrapping Up:

Hopefully, I think this article delivered some useful information on the @kouts/vue-modal plugin to integrate into the 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", defaul

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. T

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 Versioning Url Path Versioning Media 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.A

.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 f

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: PickerController PickerOptions 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&quo

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 bel

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-Control Pragma Vary 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 fr

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 inform

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

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 @