This section explains you the steps required to create a simple pager and demonstrate the basic usage of the pager component in Vue environment.
You can use Vue CLI
to setup your vue applications.
To install Vue CLI use the following commands.
npm install -g @vue/cli
npm install -g @vue/cli-init
Start a new Vue application using below Vue CLI command.
vue init webpack-simple quickstart
cd quickstart
npm install
All the available Essential JS 2 packages are published in npmjs.com
registry.
To install pager component, use the following command
npm install @syncfusion/ej2-vue-grids --save
The —save will instruct NPM to include the grid package inside of the
dependencies
section of thepackage.json
.
You can register the pager component in your application by using the Vue.use()
.
Refer to the code example given below.
import { PagerPlugin } from '@syncfuion/ej2-vue-grids';
Vue.use(PagerPlugin);
The pager has different themes. They are:
Import pager component CSS as given below in <style>
section of the App.vue
file.
<style>
<!-- Material theme used for this sample -->
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
Add the Vue pager by using <ejs-pager>
selector in <template>
section of the App.vue
file.
Import pager plugin into Vue application[src/App.vue] from the package @syncfusion/ej2-vue-grids
.
Now place the below pager code in the App.vue
.
Here the pager is rendered with totalRecordsCount
which is used to render numeric container.
<template>
<div id="app">
<ejs-pager> </ejs-pager>
</div>
</template>
<script>
import Vue from 'vue';
import { PagerPlugin } from '@syncfusion/ej2-vue-grids';
Vue.use(PagerPlugin);
export default {
data () {
return {
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
Modify the template in [src/app.vue] file to render the pager component.
<template>
<div id="app">
<ejs-pager :totalRecordsCount='20'> </ejs-pager>
</div>
</template>
<script>
import Vue from 'vue';
import { PagerPlugin } from '@syncfusion/ej2-vue-grids';
Vue.use(PagerPlugin);
export default {
data () {
return {
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
pageSize
value defines the number of records to be displayed per page. The default value for the pageSize
is 12.
<template>
<div id="app">
<ejs-pager :pageSize='1' :totalRecordsCount='20'> </ejs-pager>
</div>
</template>
<script>
import Vue from 'vue';
import { PagerPlugin } from '@syncfusion/ej2-vue-grids';
Vue.use(PagerPlugin);
export default {
data () {
return {
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
pageCount
value defines the number of pages to be displayed in the pager component for navigation.
The default value for pageCount
is 10 and value will be updated based on totalRecordsCount
and pageSize
values.
<template>
<div id="app">
<ejs-pager :pageSize='1' :pageCount='3' :totalRecordsCount='20'> </ejs-pager>
</div>
</template>
<script>
import Vue from 'vue';
import { PagerPlugin } from '@syncfusion/ej2-vue-grids';
Vue.use(PagerPlugin);
export default {
data () {
return {
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
Use the following command to run the application in browser.
npm run dev
Output will be appears as follows.
<template>
<div id="app">
<ejs-pager :pageSize='1' :pageCount='3' :totalRecordsCount='20'> </ejs-pager>
</div>
</template>
<script>
import Vue from 'vue';
import { PagerPlugin } from '@syncfusion/ej2-vue-grids';
Vue.use(PagerPlugin);
export default {
data () {
return {
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>