Vue Grid | Get Started with ag-Grid and Vue

ag-Grid is the industry standard for Vue Enterprise Applications. Developers using ag-Grid are building applications that would not be possible if ag-Grid did not exist.

Quick Look Code Example
import "@ag-grid-community/all-modules/dist/styles/ag-grid.css"; import "@ag-grid-community/all-modules/dist/styles/ag-theme-balham.css"; // or, if using Enterprise features // import "@ag-grid-enterprise/all-modules/dist/styles/ag-grid.css"; // import "@ag-grid-enterprise/all-modules/dist/styles/ag-theme-balham.css"; import { AgGridVue } from '@ag-grid-community/vue'; import {AllCommunityModules} from '@ag-grid-community/all-modules'; export const App = { name: 'App', data() { return { columnDefs: null, rowData: null, modules: AllCommunityModules } }, components: { AgGridVue }, beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make'}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; this.rowData = [ {make: 'Toyota', model: 'Celica', price: 35000}, {make: 'Ford', model: 'Mondeo', price: 32000}, {make: 'Porsche', model: 'Boxter', price: 72000} ]; }, template: ` <ag-grid-vue style="width: 500px; height: 300px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules"> </ag-grid-vue> ` }
import Vue from 'vue'; import { App } from './app'; new Vue({ el: '#root', render: h => h(App) });

Getting Started

In this article, we will walk you through the necessary steps to add ag-Grid (both Community and Enterprise are covered) to an existing Vue project, configure some of the essential features of it. We will show you some of the fundamentals of the grid (passing properties, using the API, etc). As a bonus, we will also tweak the grid's visual appearance using Sass variables.

Add ag-Grid to Your Project

For the purposes of this tutorial, we are going to scaffold an Vue app with Vue CLI. Don't worry if your project has a different configuration. Ag-Grid and its Vue wrapper are distributed as NPM packages, which should work with any common Vue project module bundler setup. Let's follow the Vue CLI instructions - run the following in your terminal:

npm install -g @vue/cli vue create my-project

When prompted choose "Manually select features":

Manually Select Features

Next, select Babel and CSS Pre-processors (we've also deselected Linter here, but this is optional):

Select Features

Next select SASS/SCSS as the CSS Pre-processor:

CSS Pre-processor

Finally choose where to store the configuration data - we've opted for dedicated config files:

Config files

We're not ready to start our application:

cd my-project npm run serve

If everything goes well, npm run serve has started the web server. You can open the default app at localhost:8080.

As a next step, let's add the ag-Grid NPM packages. run the following command in my-project (you may need a new instance of the terminal):

npm install --save @ag-grid-community/all-modules @ag-grid-community/vue vue-property-decorator # or, if using Enterprise featuers npm install --save @ag-grid-enterprise/all-modules @ag-grid-community/vue vue-property-decorator

After a few seconds of waiting, you should be good to go. Let's get to the actual coding! As a first step, let's add the ag-Grid the ag-Grid styles - import them in the style section of src/App.vue:

<style lang="scss"> @import "../node_modules/@ag-grid-community/all-modules/dist/styles/ag-grid.css"; @import "../node_modules/@ag-grid-community/all-modules/dist/styles/ag-theme-balham.css"; // or, if using Enterprise featuers // @import "../node_modules/@ag-grid-enterprise/all-modules/dist/styles/ag-grid.css"; // @import "../node_modules/@ag-grid-enterprise/all-modules/dist/styles/ag-theme-balham.css"; </style>

The code above imports the grid "structure" stylesheet (ag-grid.css), and one of the available grid themes: (ag-theme-balham.css). The grid ships several different themes; pick one that matches your project design.

In a later section we documentation on how you can Customise the Theme Look using SCSS, which is our recommended approach.

As this will be a simple example we can delete the src/components directory. Our example application will live in src/App.vue.

Let's add the component definition to our template. Edit app/App.vue and replace the scaffold code:

<template> <ag-grid-vue style="width: 500px; height: 500px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules"> </ag-grid-vue> </template>

Next, let's declare the basic grid configuration. Edit src/App.vue:

<script> import {AgGridVue} from "@ag-grid-community/vue"; import {AllCommunityModules} from '@ag-grid-community/all-modules'; export default { name: 'App', data() { return { columnDefs: null, rowData: null, modules: AllCommunityModules } }, components: { AgGridVue }, beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make'}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; this.rowData = [ {make: 'Toyota', model: 'Celica', price: 35000}, {make: 'Ford', model: 'Mondeo', price: 32000}, {make: 'Porsche', model: 'Boxter', price: 72000} ]; } } </script>

The code above presents three essential configuration properties of the grid - the column definitions (columnDefs), the data (rowData) and the modules we wish to use.

You can find out more about modules here, but for now all you need to know is that modules make up the parts of the grid that you wish to use. In this case we're going to use all the functionality in the Community version of ag-Grid.

In our case, the column definitions contain three columns; each column entry specifies the header label and the data field to be displayed in the body of the table.

This is the ag-grid component definition, with two property bindings - rowData and columnDefs. The component also accepts the standard DOM style and class. We have set the class to ag-theme-balham, which defines the grid theme. As you may have already noticed, the CSS class matches the name of CSS file we imported earlier.

Finally, note that we've imported the @ag-grid-community/vue component - this is actual component that will provide the ag-Grid functionality.

If everything works as expected, you should see a simple grid like the one on the screenshot:

ag-Grid hello world

Enable Sorting And Filtering

So far, so good. But wouldn't it be nice to be able to sort the data to help us see which car is the least/most expensive? Well, enabling sorting in ag-Grid is actually quite simple - all you need to do is set the sortable property to the column definitions.

this.columnDefs = [ {headerName: 'Make', field: 'make', sortable: true }, {headerName: 'Model', field: 'model', sortable: true }, {headerName: 'Price', field: 'price', sortable: true } ];

After adding the property, you should be able to sort the grid by clicking on the column headers. Clicking on a header toggles through ascending, descending and no-sort.

Our application doesn't have too many rows, so it's fairly easy to find data. But it's easy to imagine how a real-world application may have hundreds (or even hundreds of thousands!) or rows, with many columns. In a data set like this filtering is your friend.

As with sorting, enabling filtering is as easy as setting the filter property:

this.columnDefs = [ {headerName: 'Make', field: 'make', sortable: true, filter: true }, {headerName: 'Model', field: 'model', sortable: true, filter: true }, {headerName: 'Price', field: 'price', sortable: true, filter: true } ];

With this property set, the grid will display a small column menu icon when you hover the header. Pressing it will display a popup with filtering UI which lets you choose the kind of filter and the text that you want to filter by.

ag-Grid sorting and filtering

Fetch Remote Data

Displaying hard-coded data in JavaScript is not going to get us very far. In the real world, most of the time, we are dealing with data that resides on a remote server. Thanks to React, implementing this is actually quite simple. Notice that the actual data fetching is performed outside of the grid component - We are using the HTML5 fetch API.

Now, let's remove the hard-coded data and fetch one from a remote server. Edit the src/App.vue and add the following fetch statement:

beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make'}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; fetch('https://api.myjson.com/bins/15psn9') .then(result => result.json()) .then(rowData => this.rowData = rowData); }

The remote data is the same as the one we initially had, so you should not notice any actual changes to the grid. However, you will see an additional HTTP request performed if you open your developer tools.

Enable Selection

Being a programmer is a hectic job. Just when we thought that we are done with our assignment, the manager shows up with a fresh set of requirements! It turned out that we need to allow the user to select certain rows from the grid and to mark them as flagged in the system. We will leave the flag toggle state and persistence to the backend team. On our side, we should enable the selection and, afterwards, to obtain the selected records and pass them with an API call to a remote service endpoint.

Fortunately, the above task is quite simple with ag-Grid. As you may have already guessed, it is just a matter of adding and changing couple of properties.

<template> <ag-grid-vue style="width: 500px; height: 500px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules" rowSelection="multiple"> </ag-grid-vue> </template> <script> import {AgGridVue} from "@ag-grid-community/vue"; import {AllCommunityModules} from '@ag-grid-community/all-modules'; export default { name: 'App', data() { return { columnDefs: null, rowData: null } }, components: { AgGridVue }, beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make', checkboxSelection: true}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; fetch('https://api.myjson.com/bins/15psn9') .then(result => result.json()) .then(rowData => this.rowData = rowData); } } </script> <style> </style>

Next, let's enable multiple row selection, so that the user can pick many rows:

<ag-grid-vue style="width: 500px; height: 500px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules" rowSelection="multiple"> </ag-grid-vue>

We've added a checkbox to the make column with checkboxSelection: true and then enabled multiple row selection with rowSelection="multiple".

We took a bit of a shortcut here, by not binding the property value. Without [], the assignment will pass the attribute value as a string, which is fine for our purposes.

Great! Now the first column contains a checkbox that, when clicked, selects the row. The only thing we have to add is a button that gets the selected data and sends it to the server. To do this, we are going to use the ag-Grid API - we will store a reference to both the grid and column API's in the gridReady event

To test this we'll add a button that gets the selected data and sends it to the server. Let's go ahead and make these changes:

<template> <div> <button @click="getSelectedRows()">Get Selected Rows</button> <ag-grid-vue style="width: 500px; height: 500px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules" rowSelection="multiple" @grid-ready="onGridReady"> </ag-grid-vue> </div> </template> <script> import {AgGridVue} from "@ag-grid-community/vue"; import {AllCommunityModules} from '@ag-grid-community/all-modules'; export default { name: 'App', data() { return { columnDefs: null, rowData: null } }, components: { AgGridVue }, methods: { onGridReady(params) { this.gridApi = params.api; this.columnApi = params.columnApi; }, getSelectedRows() { const selectedNodes = this.gridApi.getSelectedNodes(); const selectedData = selectedNodes.map( node => node.data ); const selectedDataStringPresentation = selectedData.map( node => node.make + ' ' + node.model).join(', '); alert(`Selected nodes: ${selectedDataStringPresentation}`); } }, beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make', checkboxSelection: true}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; fetch('https://api.myjson.com/bins/15psn9') .then(result => result.json()) .then(rowData => this.rowData = rowData); } } </script> <style> </style>

Well, we cheated a bit. Calling alert is not exactly a call to our backend. Hopefully you will forgive us this shortcut for the sake of keeping the article short and simple. Of course, you can substitute that bit with a real-world application logic after you are done with the tutorial.

Grouping

Grouping is a feature exclusive to ag-Grid Enterprise. You are free to trial ag-Grid Enterprise to see what you think. You only need to get in touch if you want to start using ag-Grid Enterprise in a project intended for production.

In addition to filtering and sorting, grouping is another effective way for the user to make sense out of large amounts of data. In our case, the data is not that much. Let's switch to a slightly larger data set:

beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make', checkboxSelection: true}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; - fetch('https://api.myjson.com/bins/15psn9') - .then(result => result.json()) - .then(rowData => this.rowData = rowData); + fetch('https://api.myjson.com/bins/ly7d1') + .then(result => result.json()) + .then(rowData => this.rowData = rowData); }
ag-Grid final

Now, let's enable grouping! Add an autoGroupColumnDef property, bind to it, and update the columnDefs with a rowGroup:

<template> <div> <button @click="getSelectedRows()">Get Selected Rows</button> <ag-grid-vue style="width: 500px; height: 500px;" class="ag-theme-balham" :columnDefs="columnDefs" :rowData="rowData" :modules="modules" rowSelection="multiple" @grid-ready="onGridReady"> </ag-grid-vue> </div> </template> <script> import {AgGridVue} from "@ag-grid-community/vue"; import {AllCommunityModules} from '@ag-grid-community/all-modules'; export default { name: 'App', data() { return { columnDefs: null, rowData: null, gridApi: null, columnApi: null, autoGroupColumnDef: null } }, components: { AgGridVue }, methods: { onGridReady(params) { this.gridApi = params.api; this.columnApi = params.columnApi; }, getSelectedRows() { const selectedNodes = this.gridApi.getSelectedNodes(); const selectedData = selectedNodes.map(node => node.data); const selectedDataStringPresentation = selectedData.map(node => node.make + ' ' + node.model).join(', '); alert(`Selected nodes: ${selectedDataStringPresentation}`); } }, beforeMount() { this.columnDefs = [ {headerName: 'Make', field: 'make', rowGroup: true}, {headerName: 'Model', field: 'model'}, {headerName: 'Price', field: 'price'} ]; this.autoGroupColumnDef = { headerName: 'Model', field: 'model', cellRenderer: 'agGroupCellRenderer', cellRendererParams: { checkbox: true } }; fetch('https://api.myjson.com/bins/15psn9') .then(result => result.json()) .then(rowData => this.rowData = rowData); } } </script> <style> </style>

There we go! The grid now groups the data by make, while listing the model field value when expanded. Notice that grouping works with checkboxes as well - the groupSelectsChildren property adds a group-level checkbox that selects/deselects all items in the group.

Don't worry if this step feels a bit overwhelming - the grouping feature is very powerful and supports complex interaction scenarios which you might not need initially. The grouping documentation section contains plenty of real-world runnable examples that can get you started for your particular case.

Customize the Theme Look

The last thing which we are going to do is to change the grid look and feel by modifying some of the theme's Sass variables.

By default, ag-Grid ships a set of pre-built theme stylesheets. If we want to tweak the colors and the fonts of theme, we should add a Sass preprocessor to our project, override the theme variable values, and refer the ag-grid Sass files instead of the pre-built stylesheets so that the variable overrides are applied.

The vue cli did a lot of for us including providing support for Sass. Let's switch to using the provided ag-Grid SCSS files - replace the style block in src/App.vue with:

<style lang="scss"> @import "../node_modules/@ag-grid-community/all-modules/src/styles/ag-grid.scss"; @import "../node_modules/@ag-grid-community/all-modules/src/styles/ag-theme-balham/sass/ag-theme-balham.scss"; // or, if using Enterprise features // @import "../node_modules/@ag-grid-community/all-modules/src/styles/ag-grid.scss"; // @import "../node_modules/@ag-grid-community/all-modules/src/styles/ag-theme-balham/sass/ag-theme-balham.scss"; </style>

If everything is configured correctly, the second row of the grid will get slightly darker. Congratulations! You now know now bend the grid look to your will - there are a few dozens more Sass variables that let you control the font family and size, border color, header background color and even the amount of spacing in the cells and columns. The full Sass variable list is available in the themes documentation section.

Summary

With this tutorial, we managed to accomplish a lot. Starting from the humble beginnings of a three row / column setup, we now have a grid that supports sorting, filtering, binding to remote data, selection and even grouping! While doing so, we learned how to configure the grid, how to access its API object, and how to change the styling of the component.