Skip to main content

Vue2 & 3 Datatables Component | Pagination, Sorting, and filtering

In this vue2-datatables demo example, I'm using below libraries to achieve Vue2 data tables,
1.      Vue-tables-2 library
2.      Axios promise based library

We can do the following things with Vue2 Datatables,
1.      Filter
2.      Sorting
3.      Pagination
4.      Grouping

All the data is passed in the following GET parameters,
a.      query
b.      limit
c.      page
d.      orderBy
e.      ascending
f.        byColumn

You just need to return a JSON object with two properties,
a.      data: array object
b.      count: number

Table of Contains:-
1.      Vue2 Datatables Dependencies
2.      Vue2 Datatables Compatibility
3.      Install Vue using Vue CLI
4.      Configure backend server - JSON Server
5.      Install Axios and vue-axios
6.      Create a component in your components folder
7.      Install Bootstrap 4+
8.      Install Vue-tables-2
9.      Send an Axios GET request for getting APIs data
10. Results
11. Download source code from below given link

Vue2 Datatables Dependencies:-
 => Vue.js (>=2.0)
 => Server Side: Axios OR Vue-resource (>=0.9.0) OR jQuery for the AJAX requests

Vue2 Datatables Compatibility:-
  => Vuex (>=2.0)
  => Bootstrap 3 / Bootstrap 4 / Bulma

Installation Steps in detail with code sample:-

Install Vue.js using Vue CLI:-

Install Vue CLI using below NPM command,
npm install -g @vue/cli

Create a Vue2 project using below NPM command,
vue create vuedatatable

Here, vuedatatable is the name of your project - you can change as per you. Now go to the above-created project directory folder using the below NPM command,
cd vuedatatable

Open your project on your editor, in this demo project - I'm using Visual Studio Code (VS Code). 

Now, go to new Terminal window in your opened project directory and run the server using the below NPM command,
npm run serve

Configure Backend Server (JSON Server):-

Install json-server using NPM command,
npm install -g json-server

Now, create a folder (data) in the root directory and add a Json file (your JSON data) called “db.json”

Let's see the “db.json” file data -
{
    "users": [{
           "id": "1",
           "name": "Anil",
           "qualification":"BSc., MCA, MCTS, MCP."
       },
       {
           "id": "2",
           "name": "Sunil",
           "qualification":"BSc."
       },
       {
           "id": "3",
           "name": "Sushil",
           "qualification":"BSc."
       },
       {
           "id": "4",
           "name": "Aradhya",
           "qualification":"UKG"
       },
       {
           "id": "5",
           "name": "Reena",
           "qualification":"BA, MA, BTC"
       },
       {
           "id": "6",
           "name": "code sample",
           "qualification":"BSc., MCA, MCTS, MCP."
       },
       {
           "id": "7",
           "name": "Dilip",
           "qualification":"BSc., MCA"
       },
       {
           "id": "8",
           "name": "Param",
           "qualification":"BSc., MCA"
       },
       {
           "id": "9",
           "name": "Up",
           "qualification":"BSc., MBA"
       },
       {
           "id": "10",
           "name": "Alok",
           "qualification":"BSc., MCA"
       },
       {
           "id": "11",
           "name": "Test 2",
           "qualification":"BSc., MCA"
       }]
   }

Now, start the JSON server using the below NPM command,
json-server --watch data/db.json --port 4000


Install Axios and vue-axios :-

Install below NPM command,
npm install vue-axios axios --save

Now, import these axios packages inside main.js file (src -> main.js)
import Vue from 'vue'
import App from './App.vue'

import axios from 'axios'
import VueAxios from 'vue-axios'


Vue.use(VueAxios, axios)
Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')


Create a component in your components folder:-
The name of your component is - VueDataTable.vue (name as per you).

// VueDataTable.vue
<template>
    <div>
        DataTable
  </div>
</template>

<script>
    export default {
    }
</script>

Now, import this component inside App.vue file.

<template>
    <div id="app">
        <vue-data-table></vue-data-table>
    </div>
</template>

<script>
    import VueDataTable from './components/VueDataTable'
       
export default {
        name: 'app',
components: {
        VueDataTable
    }
    }
</script>
    <style>
        #app {
            font - family: 'Avenir', Helvetica, Arial, sans-serif;
        -webkit-font-smoothing: antialiased;
        -moz-osx-font-smoothing: grayscale;
        text-align: center;
        color: #2c3e50;
        margin-top: 10px;
      }
</style>

Install Bootstrap 4 library:-

Use the below NPM command,
npm install bootstrap --save

Now, Import the bootstrap file in the main.js file.
// main.js
import '../node_modules/bootstrap/dist/css/bootstrap.min.css'

Install vue-tables-2 library:-

Install the below NPM command,
npm install vue-tables-2 --save

Now, register vue-tables-2 in the main.js file and its looks like,
import Vue from 'vue'
import App from './App.vue'

import axios from 'axios'
import VueAxios from 'vue-axios'

import '../node_modules/bootstrap/dist/css/bootstrap.min.css'
import { ClientTable } from 'vue-tables-2';

Vue.use(ClientTable);

Vue.use(VueAxios, axios)
Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')


Send an Axios GET request:-
Now send a GET request to the “json-server” to fetch the JSON data.

this.axios.get('http://localhost:4000/users').then(result => {
    this.tableData = result.data
})

Note: You can use your APIs and others to fetch the JSON data.

Let's see the VueDataTable.vue file,

// VueDataTable.vue
<template>
  <div class="container">
      <v-client-table
          :data="tableData"
          :columns="columns"
          :options="options">
      </v-client-table>
  </div>
</template>

<script>
export default {
    data() {
        return {
            columns: ['id', 'name', 'qualification'],
            tableData: [],
            options: {
                headings: {
                    id: 'UserID',
                    name: 'User Name',
                    qualification:'User Qualification'
                },
                sortable: ['name', 'qualification'],
                filterable: ['name', 'qualification']
            }
        }
    },
    mounted() {
        this.axios.get('http://localhost:4000/users').then(result => {
            this.tableData = result.data
        })
    }
}
</script>

<style>
#app {
  width: 95%;
  margin-top: 50px;
}

.VuePagination {
  text-align: center;
}

.vue-title {
  text-align: center;
  margin-bottom: 10px;
}

.vue-pagination-ad {
  text-align: center;
}

.glyphicon.glyphicon-eye-open {
  width: 16px;
  display: block;
  margin: 0 auto;
}

th:nth-child(3) {
  text-align: center;
}

.VueTables__child-row-toggler {
  width: 16px;
  height: 16px;
  line-height: 16px;
  display: block;
  margin: auto;
  text-align: center;
}

.VueTables__child-row-toggler--closed::before {
  content: "+";
}

.VueTables__child-row-toggler--open::before {
  content: "-";
}

</style>

Results:-
Let's see the resulting pic.

Download: SourceCode from here...

Labels

Labels:
By Anil Singh | Rating of this article (*****)

Popular posts from this blog

List of Countries, Nationalities and their Code In Excel File

Download JSON file for this List - Click on JSON file    Countries List, Nationalities and Code Excel ID Country Country Code Nationality Person 1 UNITED KINGDOM GB British a Briton 2 ARGENTINA AR Argentinian an Argentinian 3 AUSTRALIA AU Australian an Australian 4 BAHAMAS BS Bahamian a Bahamian 5 BELGIUM BE Belgian a Belgian 6 BRAZIL BR Brazilian a Brazilian 7 CANADA CA Canadian a Canadian 8 CHINA CN Chinese a Chinese 9 COLOMBIA CO Colombian a Colombian 10 CUBA CU Cuban a Cuban 11 DOMINICAN REPUBLIC DO Dominican a Dominican 12 ECUADOR EC Ecuadorean an Ecuadorean 13 EL SALVA...
Read more

nullinjectorerror no provider for httpclient angular 17

In Angular 17 where the standalone true option is set by default, the app.config.ts file is generated in src/app/ and provideHttpClient(). We can be added to the list of providers in app.config.ts Step 1:   To provide HttpClient in a standalone app we could do this in the app.config.ts file, app.config.ts: import { ApplicationConfig } from '@angular/core'; import { provideRouter } from '@angular/router'; import { routes } from './app.routes'; import { provideClientHydration } from '@angular/platform-browser'; //This (provideHttpClient) will help us to resolve the issue  import {provideHttpClient} from '@angular/common/http'; export const appConfig: ApplicationConfig = {   providers: [ provideRouter(routes),  provideClientHydration(), provideHttpClient ()      ] }; The appConfig const is used in the main.ts file, see the code, main.ts : import { bootstrapApplication } from '@angular/platform-browser'; import { appConfig } from ...
Read more

React Lifecycle Components | Mounting, Updating, Unmounting

In React, each component has a life-cycle which manipulate during its three main phases. The following three phases are: 1.       Mounting 2.       Updating 3.       Unmounting React does so by “ Mounting ” (adding nodes to the DOM), “ Unmounting ” (removing them from the DOM), and “ Updating ” (making changes to nodes already in the DOM). Mounting - Lifecycle Phase 1 Mounting is used for adding nodes (elements) to the DOM. The React has four built-in methods that gets called, in this order, when mounting a component - 1.       constructor() 2.       getDerivedStateFromProps() 3.       render() 4.       componentDidMount() Note – 1)       The render() method is required and It always be called and the others methods are optional (you will call...
Read more

51 Best React Interview Questions and Answers

1) What Is React? React is a fast, open-source, and front-end JavaScript library and It was developed by Facebook in 2011 for building complex, stateful and interactive UI in web as well as mobile Applications. React follows the component based approach which helps you to building reusable and interactive web and mobile user interface (UI) components. React has one of the largest communities supporting it. The high level component Lifecycle - At the highest level component Lifecycle, React components have lifecycle events that are - 1.       Initialization 2.       State/Property Updates 3.       Destruction Explore to detail understanding   -  React Lifecycle Components Reactjs is very fast technology that can be trusted for complex tasks and can simply be trusted for quality outcomes. 2) When Reactjs released? March 2013 3) What Is the current stable version of ...
Read more

39 Best Yii2 Interview Questions and Answers - PHP Frameworks

1: What Is Yii framework? 2: Why Yii Is So Fast? 3: Yii Versions? 4: What Are the Prerequisites Yii? 5: Why Use Yii 2.0 Framework? 6: What Are the Benefits of Yii over other Frameworks? 7: What's New in Yii Release 2.0? 8: What Is The First File That Gets Loaded When You Run A Application Using Yii? 9: What Is The First Function That Gets Loaded From A Controller? 10: What Are the core components of Yii2 framework? 11: What Are the great feature of Yii Framework? 12: What Are The Application Structure of Yii 2.0 Framework? 13: What Are the Naming Convention in Yii 2.0 Framework? 14: What Is Request Life-Cycle of Yii 2.0 framework? 15: What Are Yii helpers? 16: What Are the Core Helper Classes in Yii Framework? 17: What Are The Server Requirements to Install Yii 2.0 Framework? 18: How To Customizing Helper Classes in Yii Framework? 19: What Are The Directory Structure of Yii 2.0 Framework? 20: How To Create Directory Structure of Yii Framewor...
Read more