Getting Started with the Vue Split button Component in Vue 2

25 Apr 20257 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 Split button component using theComposition API /Options API.

Prerequisites

System requirements for Syncfusion^® Vue UI components

Dependencies

The list of dependencies required to use the SplitButton component in your application is given as follows:

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

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 Split button component as an example. Install the@syncfusion/ej2-vue-splitbuttons package by running the following command:

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

or

yarn add @syncfusion/ej2-vue-splitbuttons

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 Split button 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';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';</style>

Add Syncfusion^® Vue component

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

1. First, import and register the Split button 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{SplitButtonComponentasEjsSplitbutton}from"@syncfusion/ej2-vue-splitbuttons";</script>

<script>import{SplitButtonComponent}from"@syncfusion/ej2-vue-splitbuttons";exportdefault{components:{'ejs-splitbutton':SplitButtonComponent}}</script>

2. In thetemplate section, define the Split button component with theitems andcontent property.

<template><ejs-splitbutton:items='items'content='Paste'></ejs-splitbutton></template>

3. Declare the value for theitems property in thescript section.

<script>constitems=[{text:'Cut'},{text:'Copy'},{text:'Paste'}];</script>

<script>data(){return{items:[{text:'Cut'},{text:'Copy'},{text:'Paste'}]};}</script>

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

<template><ejs-splitbutton:items='items'content='Paste'></ejs-splitbutton></template><scriptsetup>import{SplitButtonComponentasEjsSplitbutton}from"@syncfusion/ej2-vue-splitbuttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);constitems=[{text:'Cut'},{text:'Copy'},{text:'Paste'}];</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';</style>

<template><ejs-splitbutton:items='items'content='Paste'></ejs-splitbutton></template><script>import{SplitButtonComponent}from"@syncfusion/ej2-vue-splitbuttons";import{enableRipple}from'@syncfusion/ej2-base';enableRipple(true);exportdefault{name:"App",components:{'ejs-splitbutton':SplitButtonComponent},data(){return{items:[{text:'Cut'},{text:'Copy'},{text:'Paste'}]};}}</script><style>@import'../node_modules/@syncfusion/ej2-base/styles/material.css';@import'../node_modules/@syncfusion/ej2-buttons/styles/material.css';@import'../node_modules/@syncfusion/ej2-popups/styles/material.css';@import'../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';</style>

Run the project

To run the project, use the following command:

npm run serve

or

yarn run serve

Preview SampleOpen in Stackblitz

See Also

• SplitButton with icons