ag-grid-vue

AG Grid Vue 2 Component

Usage no npm install needed!

<script type="module">
  import agGridVue from 'https://cdn.skypack.dev/ag-grid-vue';
</script>

README

alt text

CDNJS npm Bundle Phobia Github Stars Twitter

AG Grid Vue Component

AG Grid is a fully-featured and highly customizable JavaScript data grid. It delivers outstanding performance, has no 3rd party dependencies and integrates smoothly with React as React Component. Here's how our grid looks like with multiple filters and grouping enabled:

alt text

Features

Besides the standard set of features you'd expect from any grid:

  • Column Interactions (resize, reorder, and pin columns)
  • Pagination
  • Sorting
  • Row Selection

Here are some of the features that make AG Grid stand out:

  • Grouping / Aggregation*

  • Custom Filtering

  • In-place Cell Editing

  • Records Lazy Loading *

  • Server-Side Records Operations *

  • Live Stream Updates

  • Hierarchical Data Support & Tree View *

  • Customizable Appearance

  • Customizable Cell Contents

  • Excel-like Pivoting *

  • State Persistence

  • Keyboard navigation

  • Data Export to CSV

  • Data Export to Excel *

  • Row Reordering

  • Copy / Paste

  • Column Spanning

  • Pinned Rows

  • Full Width Rows

  • The features marked with an asterisk are available in the enterprise version only.

Check out developers documentation for a complete list of features or visit our official docs for tutorials and feature demos.

Usage Overview

Use the setup instructions below or go through a 5-minute-quickstart guide.

Install dependencies

npm install --save ag-grid-community ag-grid-vue vue-property-decorator@^8.0.0

Declare the grid, row and columns and styles

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

Set the grid's configuration in the component

<script>
    import { AgGridVue } from "ag-grid-vue";

    export default {
        name: 'App',
        data() {
            return {
                columnDefs: null,
                rowData: null
            }
        },
        components: {
            AgGridVue
        },
        beforeMount() {
            this.columnDefs = [
                { field: 'make' },
                { field: 'model' },
                { field: 'price' }
            ];

            this.rowData = [
                { make: 'Toyota', model: 'Celica', price: 35000 },
                { make: 'Ford', model: 'Mondeo', price: 32000 },
                { make: 'Porsche', model: 'Boxter', price: 72000 }
            ];
        }
    }
</script>

<style lang="scss">
    @import "../node_modules/ag-grid-community/dist/styles/ag-grid.css";
    @import "../node_modules/ag-grid-community/dist/styles/ag-theme-alpine.css";
</style>

Please refer the Get Started with Vue for a full walkthrough on how to use Vue with AG Grid.

Issue Reporting

If you have found a bug, please report them at this repository issues section. If you're using Enterprise version please use the private ticketing system to do that. For more information on support check out our dedicated page.

Asking Questions

Look for similar problems on StackOverflow using the ag-grid tag. If nothing seems related, post a new message there. Do not use GitHub issues to ask questions.

Contributing

AG Grid is developed by a team of co-located developers in London. If you want to join the team check out our jobs listing or send your application to info@ag-grid.com.

License

This project is licensed under the MIT license. See the LICENSE file for more info.