Search results

Getting Started with Vue 3 in Vue Message component

25 Jan 2023 / 3 minutes to read

This section explains how to use the Syncfusion Vue Message component in Vue 3 application.

Prerequisites

System requirements for Syncfusion Vue UI components

Creating Vue application using Vue CLI

The easiest way to create a Vue application is to use the Vue CLI. The Vue CLI versions above 4.5.0 are mandatory for creating applications using Vue 3. Use the following command to uninstall older versions of the Vue CLI.

Copied to clipboard
npm uninstall vue-cli -g

Use the following commands to install the latest version of the Vue CLI.

Copied to clipboard
npm install -g @vue/cli
npm install -g @vue/cli-init

Create a new project using the following command.

Copied to clipboard
vue create quickstart

Initiating a new project prompts you to choose the type of project to be used for the current application. Select the option Default (Vue 3) from the menu.

Reference

Adding Syncfusion packages

The Syncfusion Vue packages are maintained in the npmjs.com registry. The Message component will be used in this example. To install it, use the following command.

Copied to clipboard
npm install @syncfusion/ej2-vue-notifications --save

Adding CSS reference

Import the needed CSS styles for the Message component along with dependency styles in the <style> section of the src/App.vue file as follows.

Copied to clipboard
<style>
  @import "../node_modules/@syncfusion/ej2-base/styles/material.css";
  @import "../node_modules/@syncfusion/ej2-vue-notifications/styles/message/material.css";
</style>

Adding Message component

You have completed all the necessary configurations needed for rendering the Syncfusion Vue Message component. Now, add the Message component using the following steps.

  1. Import the Message component in the <script> section of the src/App.vue file.
Copied to clipboard
 <script>
 import { MessageComponent } from "@syncfusion/ej2-vue-notifications";
 </script>
  1. Register the Message component in the src/App.vue file which are used in this example.
Copied to clipboard
 import { MessageComponent } from '@syncfusion/ej2-vue-notifications';
 // Component registration
 export default {
    name: "App",
    components: {
       'ejs-message': MessageComponent
    }
 }
  1. Add the component definition in the template section. Here, the content property binding definition.
Copied to clipboard
 <template>
    <ejs-message id="msg" :content="content"></ejs-message>
 </template>

Above is the Message component definition, with content property binding definition.

  1. Declare the bound properties in the script section.
Copied to clipboard
export default {
   name: 'App',
   components: {
      'ejs-Message': MessageComponent
   },
   data() {
      return {
         content: "Please read the comments carefully"
     }
   },
};
  1. Summarizing the above steps, update the src/App.vue file with the following code.
Copied to clipboard
 <template>
    <ejs-message id="msg" :content="content"></ejs-message>
 </template>
 <script>
 import { MessageComponent } from "@syncfusion/ej2-vue-notifications";
 export default {
    name: "app",
    components: {
       "ejs-message": MessageComponent
    },
    data() {
       return {
          content: "Please read the comments carefully",
       };
    }
 }
 </script>
 <style>
    @import "../node_modules/@syncfusion/ej2-base/styles/material.css";
    @import "../node_modules/@syncfusion/ej2-vue-notifications/styles/message/material.css";
 </style>

Running the application

Run the application using the following command.

Copied to clipboard
npm run serve

A web server will be initiated. Open the quick start app in the browser at port localhost:8080.

Message component.