Getting started
27 Feb 20233 minutes to read
This section explains how to create a simple ProgressButton and to configure the ProgressButton component.
Prerequisites
System requirements for Syncfusion Vue UI components
Dependencies
The list of dependencies required to use the ProgressButton component in your application is given as follows:
|-- @syncfusion/ej2-vue-splitbuttons
|-- @syncfusion/ej2-vue-base
|-- @syncfusion/ej2-base
|-- @syncfusion/ej2-splitbuttons
|-- @syncfusion/ej2-popups
|-- @syncfusion/ej2-buttons
Installation and configuration
You can use Vue CLI
to setup your Vue applications.
To install Vue CLI use the following command.
npm install -g @vue/cli
npm install -g @vue/cli-init
Start a new project using below Vue CLI command.
vue init webpack-simple quickstart
cd quickstart
npm install
Install Syncfusion ProgressButton
packages using below command.
npm install @syncfusion/ej2-vue-splitbuttons --save
Registering ProgressButton component using Vue.use()
Import the ProgressButton Plugin from the Essential JS 2 Vue package and register the same using Vue.use()
with Component Plugin as its argument.
Refer to the code snippet given below.
import Vue from 'vue';
import { ProgressButtonPlugin } from "@syncfusion/ej2-vue-splitbuttons";
Vue.use(ProgressButtonPlugin);
export default {}
By registering component plugin in Vue, all child directives are also globally registered. We can also use
Vue.Component()
to registerProgressButton
. Refer here to know more about component registration.
Initialize ProgressButton
Add the EJ2 Vue ProgressButton using <ejs-progressbutton>
to the <template>
section of the App.vue
file in src
directory.
<template>
<ejs-progressbutton content="Spin Left"></ejs-progressbutton>
</template>
<script>
import Vue from 'vue';
import { ProgressButtonPlugin } from "@syncfusion/ej2-vue-splitbuttons";
Vue.use(ProgressButtonPlugin);
export default {}
</script>
Adding CSS Reference
Add ProgressButton component’s styles as given below in <style>
section of the 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>
Run the application
Now run the npm run dev
command in the console, it will build your application and open in the browser.
The following example shows a basic ProgressButton component.
<template>
<ejs-progressbutton content="Spin Left"></ejs-progressbutton>
</template>
<script>
import Vue from 'vue';
import { ProgressButtonPlugin } from "@syncfusion/ej2-vue-splitbuttons";
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
Vue.use(ProgressButtonPlugin);
export default {}
</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>
ProgressButton supports different styles, types and sizes like
Button
. In addition, it also supportstop
andbottom
icon positions.
Enable progress in button
You can enable the background filler UI by setting the enableProgress
property to true
.
<template>
<ejs-progressbutton content="Spin Left" :enableProgress="true"></ejs-progressbutton>
</template>
<script>
import Vue from 'vue';
import { ProgressButtonPlugin } from "@syncfusion/ej2-vue-splitbuttons";
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
Vue.use(ProgressButtonPlugin);
export default {}
</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>