@ag-grid-community/vue

AG Grid Vue 2 Component

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@ag-grid-community/vue
9,1543528.1.1a month ago3 years agoMinified + gzip package size for @ag-grid-community/vue in KB

Readme

AG Grid HTML5 Grid trusted by the community, built for enterprise
CDNJS npm npm
AG Grid Vue Component
AG Grid is a fully-featured and highly customizable JavaScript data grid. It delivers outstanding performance, has no third-party dependencies and integrates smoothly with Vue.
Here's how our grid looks with multiple filters and grouping enabled:
Image of AG Grid showing filtering and grouping enabled.

Features

In addition to 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
  • Accessibility support
  • 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
  • State Persistence
  • Keyboard Navigation
  • Data Export to CSV
  • Data Export to Excel
  • Excel-like Pivoting
  • Row Reordering
  • Copy / Paste
  • Column Spanning
  • Pinned Rows
  • Full Width Rows
  • Integrated Charting
  • Sparklines

\ The features marked with an asterisk are available in the Enterprise version only.
Check out the developer documentation for a complete list of features or visit our official docs for tutorials and feature demos.

Getting started

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

Install dependencies

$ npm install --save @ag-grid-community/core @ag-grid-community/vue

Import the AgGridVue Component

import { AgGridVue } from "@ag-grid-community/vue";

Import styles in

import "@ag-grid-community/styles/ag-grid.css";
import "@ag-grid-community/styles/ag-theme-alpine.css";

Set the grid's configuration in the parent component

export default {
  name: "App",
  components: {
    AgGridVue,
  },
  setup() {
    return {
      columnDefs: [
        { headerName: "Make", field: "make" },
        { headerName: "Model", field: "model" },
        { headerName: "Price", field: "price" },
      ],
      rowData: [
        { make: "Toyota", model: "Celica", price: 35000 },
        { make: "Ford", model: "Mondeo", price: 32000 },
        { make: "Porsche", model: "Boxster", price: 72000 },
      ],
    };
  },
};

Render the grid

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

Complete example:

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

<script>
import "@ag-grid-community/styles/ag-grid.css";
import "@ag-grid-community/styles/ag-theme-alpine.css";
import { AgGridVue } from "@ag-grid-community/vue";

export default {
  name: "App",
  components: {
    AgGridVue,
  },
  setup() {
    return {
      columnDefs: [
        { headerName: "Make", field: "make" },
        { headerName: "Model", field: "model" },
        { headerName: "Price", field: "price" },
      ],
      rowData: [
        { make: "Toyota", model: "Celica", price: 35000 },
        { make: "Ford", model: "Mondeo", price: 32000 },
        { make: "Porsche", model: "Boxster", price: 72000 },
      ],
    };
  },
};
</script>

Issue Reporting

If you have found a bug, please report it in this repository's issues section. If you're using the Enterprise version, please use the private ticketing system to do that.

Asking Questions

Look for similar problems on StackOverflow using the ag-grid tag. If nothing seems related, post a new message there. Please 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 board 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.