Getting Started with the Vue Checkbox Component in Vue 2

25 Apr 20256 minutes to read

This article provides a step-by-step guide for setting up a Vue 2 project usingVue-CLI and integrating the Syncfusion^® Vue Checkbox component using theComposition API /Options API.

Prerequisites

System requirements for Syncfusion^® Vue UI components

Dependencies

The list of dependencies required to use the Checkbox component in your application is given below:

|--@syncfusion/ej2-vue-buttons|--@syncfusion/ej2-base|--@syncfusion/ej2-buttons|--@syncfusion/ej2-vue-base

Setting up the Vue 2 project

To generate a Vue 2 project using Vue-CLI, use thevue create command. Follow these steps to install Vue CLI and create a new project:

npm install -g @vue/clivue create quickstartcd quickstartnpm run serve

or

yarn global add @vue/clivue create quickstartcd quickstartyarn run serve

When creating a new project, choose the optionDefault ([Vue 2] babel, eslint) from the menu.

Once thequickstart project is set up with default settings, proceed to add Syncfusion^® components to the project.

Add Syncfusion^® Vue packages

Syncfusion^® packages are available atnpmjs.com. To use Vue components, install the required npm package.

This article uses theVue Checkbox component as an example. Install the@syncfusion/ej2-vue-buttons package by running the following command:

npm install @syncfusion/ej2-vue-buttons --save

or

yarn add @syncfusion/ej2-vue-buttons

Import Syncfusion^® CSS styles

You can import themes for the Syncfusion^® Vue component in various ways, such as using CSS or SASS styles from npm packages, CDN,CRG andTheme Studio. Refer tothemes topic to know more about built-in themes and different ways to refer to themes in a Vue project.

In this article, theMaterial theme is applied using CSS styles, which are available in installed packages. The necessaryMaterial CSS styles for the Checkbox component and its dependents were imported into the<style> section ofsrc/App.vue file.

<style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';</style>

Add Syncfusion^® Vue component

Follow the below steps to add the Vue Checkbox component usingComposition API orOptions API:

1. First, import and register the Checkbox component in thescript section of thesrc/App.vue file. If you are using theComposition API, you should add thesetup attribute to thescript tag to indicate that Vue will be using theComposition API.

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

<script>import{CheckBoxComponent}from"@syncfusion/ej2-vue-buttons";exportdefault{components:{'ejs-checkbox':CheckBoxComponent}}</script>

2. In thetemplate section define the Checkbox component with thelabel

<template><ejs-checkboxlabel='Default'></ejs-checkbox></template>

Here is the summarized code for the above steps in thesrc/App.vue file:

<template><ejs-checkboxlabel='Default'></ejs-checkbox></template><scriptsetup>import{CheckBoxComponentasEjsCheckbox}from"@syncfusion/ej2-vue-buttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';.e-checkbox-wrapper{margin-top:18px;}</style>

<template><ejs-checkboxlabel='Default'></ejs-checkbox></template><script>import{CheckBoxComponent}from"@syncfusion/ej2-vue-buttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);exportdefault{name:"App",components:{'ejs-checkbox':CheckBoxComponent}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';.e-checkbox-wrapper{margin-top:18px;}</style>

Run the project

To run the project, use the following command:

npm run serve

or

yarn run serve

Preview SampleOpen in Stackblitz

Change the Checkbox state

The Essential^® JS 2 Checkbox contains 3 different states visually, they are:

• Checked
• Unchecked
• Indeterminate

The Checkboxchecked property is used to handle the checked and unchecked state. In checked state a tick mark will be added to the visualization of Checkbox.

Indeterminate

The Checkbox indeterminate state can be set throughindeterminate property. Checkbox indeterminate state masks the real value of Checkbox visually. The Checkbox cannot be changed to indeterminate state through the user interface, this state can be achieved only through the property.

<template><ul><li><ejs-checkboxlabel='Checked State'checked=true></ejs-checkbox></li><li><ejs-checkboxlabel='Unchecked State'></ejs-checkbox></li><li><ejs-checkboxlabel='Indeterminate State'indeterminate=true></ejs-checkbox></li></ul></template><scriptsetup>import{CheckBoxComponentasEjsCheckbox}from"@syncfusion/ej2-vue-buttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';.e-checkbox-wrapper{margin-top:18px;}li{list-style:none;}</style>

<template><ul><li><ejs-checkboxlabel='Checked State'checked=true></ejs-checkbox></li><li><ejs-checkboxlabel='Unchecked State'></ejs-checkbox></li><li><ejs-checkboxlabel='Indeterminate State'indeterminate=true></ejs-checkbox></li></ul></template><script>import{CheckBoxComponent}from"@syncfusion/ej2-vue-buttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);exportdefault{name:"App",components:{'ejs-checkbox':CheckBoxComponent}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';.e-checkbox-wrapper{margin-top:18px;}li{list-style:none;}</style>

Preview SampleOpen in Stackblitz