George Anderson
Frontend and backend development guru, lover of all things computer... and cats! Hopes to make your coder life a breeze by sharing some tips and tricks of the trade.
Posted on Jul 5th 2019

One of the most common components in web applications is the modal dialog. Vue modals are rather easy to create and work with, and in this tutorial, we’ll show you how! Let’s dive right in.

Getting Started: Configuring the Development Environment

For this tutorial, we will be using the Eclipse IDE with the CodeMix plugin installed.

If you’re looking for an IDE to take on development with frameworks like Angular, React, and Vue.js, or languages like Python and Rust, CodeMix has you covered. For Vue, install the Vue pack or the famed Vetur extension for Vue support. Codemix is compatible with all Eclipse-based IDEs and tools, such as MyEclipse, Spring Tools Suite, and JBoss Tools.

Creating a Vue Project using CodeMix

We can now create our application using the CodeMix Project Wizard. We’ll be using the latest version of all the tech libraries and stacks as at the time of this writing. To create a new Vue Project, navigate to File > New > Project > CodeMix > Vue Project. Ensure you choose the, “A Vue CLI-built application” option in the wizard before clicking Finish.

Once the project is completed, open the integrated Terminal+ for the project using Ctrl/Cmd + Shift + P, and executing the command, “Terminal: Create New Integrated Terminal”. If you have more than one project in your workspace, you will be asked to select your project in the command palette before the Terminal is opened.

In the Terminal, run the following commands to install the required Node modules.
npm install

After the installation is complete, you can serve the application right away, find your application in the Servers view and use the context menu run action to start serving it.

Creating the Component

In the components folder, create a file named AppModal.vue. You can do this by using the New > Vue file wizard accessible from the project’s context menu. We’ll create a very basic component for now.

Note: For more on CodeMix’s Vue capabilities, please read this article.

In App.vue, we import the AppModal component like below:

If you’re using a recent version of CodeMix, you’ve probably noticed a new browser pane beside the editor – this pane will update after you save your changes, to show you the current state of the app after your changes have been rebuilt. Do read more about LivePreview 2.0 here. Your application will now look like this:
Obviously  this is no good as the modal is open over our app – we’re going to add a condition under which the modal will show, and a button to display it.

Here we created our modal template with two div tags and one button element. The button is used to open our modal. In our second div tag, we added a v-if=isOpen directive so that our modal will only display if the isOpen property is true.

Introducing Vue.js Slots

Vue.js slots are handy when we want to embed content inside child components. So let’s allow the App.vue component to pass DOM elements into the AppModal.vue component. At the same time, we’ll take the opportunity to add some style to our modal, so replace the contents of AppModal.vue with the source below.

We’ll modify the template section of App.vue with the template below, to actually pass data to our modal component.


Closing the Modal

We need to find a way for passing data from the child component back to the parent, so AppModal component can say, “Hey, App component, can you close this me?”.

We’ll implement a closeModal method that will use $emit for this purpose, and we’ll call this from the button, on click.

In AppModal.vue, add the following to the scripts section

And we’ll modify our button to call this method:
<button @click="closeModal">Close</button>

Back in App.vue we need to receive the clicked event and close the modal, so add the following method to the methods section which already exists:

And we’ll modify the reference to the app-modal component to call the above method when receiving a clicked event:
<app-modal v-if="showModal" :showModal=showModal @clicked="onChildClick">

This is how your app should finally look:
Vue Modal in Action

Here are two vue files in their entirety, just in case you missed something.




In this article we’ve learnt how to create a modal dialog with Vue, and explored the use of named slots to distribute content between components. We also explored CodeMix tech like the Vue wizards, content assist and validation in .vue files, and the new Live Preview support that makes it easy for us to see changes in our app as we develop it.

You can download the source code from our GitHub repository here.