Search results

Getting Started with Vue 3 in Vue Switch component

08 Dec 2021 / 3 minutes to read

This section explains how to use Switch component in Vue 3 application.

Prerequisites

  • vue : 3+
  • node : 10.15+
  • vue-class-component : 8.0.0-rc.1

Creating Vue application using Vue CLI

The easiest way to create a Vue application is to use the Vue CLI. 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 Vue CLI.

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

Create a new project using the command below.

Copied to clipboard
vue create quickstart
cd quickstart

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

Reference

Adding Syncfusion Switch package in the application

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

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

Adding CSS reference for Syncfusion Vue Switch component

Import the needed css styles for the Switch component along with dependency styles in the <script> 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-buttons/styles/material.css";
</style>

Adding Syncfusion Vue Switch component in the application

You have completed all the necessary configurations needed for rendering the Syncfusion Vue component. Now, you are going to add the Switch component using following steps.

  1. Import the Switch component in the <script> section of the src/App.vue file.
Copied to clipboard
  <script>
  import { SwitchComponent } from "@syncfusion/ej2-vue-buttons";
  </script>
  1. Register the Switch component which is used in this example.
Copied to clipboard
    import { SwitchComponent } from "@syncfusion/ej2-vue-buttons";

    export default {
        name: "App",
        components: {
        "ejs-switch": SwitchComponent
        }
    }
  1. Add the component definition in template section.
Copied to clipboard
<template>
<ejs-switch checked=true></ejs-switch>
</template>
  1. Summarizing the above steps, update the src/App.vue file with following code.
Copied to clipboard
<template>
<ejs-switch checked=true></ejs-switch>
</template>

<script>
import { SwitchComponent } from "@syncfusion/ej2-vue-buttons";

export default {
    name: "App",
    components: {
      "ejs-switch": SwitchComponent
    }
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-vue-buttons/styles/material.css";
</style>

Running the application

Run the application using the following command.

Copied to clipboard
npm run serve

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

Output