@ag-grid-community/core

What is @ag-grid-community/core?

@ag-grid-community/core is a powerful and feature-rich JavaScript data grid library that allows developers to create complex and highly customizable data grids. It supports a wide range of functionalities including sorting, filtering, pagination, and more.

What are @ag-grid-community/core's main functionalities?

Basic Grid Setup

This code sets up a basic grid with three columns (Make, Model, Price) and three rows of data. It demonstrates the fundamental setup of a grid using @ag-grid-community/core.

const gridOptions = {
  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 }
  ]
};

const eGridDiv = document.querySelector('#myGrid');
new agGrid.Grid(eGridDiv, gridOptions);

Sorting

This code adds sorting functionality to each column in the grid. Users can click on the column headers to sort the data in ascending or descending order.

const gridOptions = {
  columnDefs: [
    { headerName: 'Make', field: 'make', sortable: true },
    { headerName: 'Model', field: 'model', sortable: true },
    { headerName: 'Price', field: 'price', sortable: true }
  ],
  rowData: [
    { make: 'Toyota', model: 'Celica', price: 35000 },
    { make: 'Ford', model: 'Mondeo', price: 32000 },
    { make: 'Porsche', model: 'Boxster', price: 72000 }
  ]
};

const eGridDiv = document.querySelector('#myGrid');
new agGrid.Grid(eGridDiv, gridOptions);

Filtering

This code enables filtering on each column. Users can filter the data by entering values in the filter input boxes that appear in the column headers.

const gridOptions = {
  columnDefs: [
    { headerName: 'Make', field: 'make', filter: true },
    { headerName: 'Model', field: 'model', filter: true },
    { headerName: 'Price', field: 'price', filter: true }
  ],
  rowData: [
    { make: 'Toyota', model: 'Celica', price: 35000 },
    { make: 'Ford', model: 'Mondeo', price: 32000 },
    { make: 'Porsche', model: 'Boxster', price: 72000 }
  ]
};

const eGridDiv = document.querySelector('#myGrid');
new agGrid.Grid(eGridDiv, gridOptions);

Pagination

This code enables pagination in the grid, allowing users to navigate through pages of data. The page size is set to 10 rows per page.

const gridOptions = {
  pagination: true,
  paginationPageSize: 10,
  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 },
    // more rows...
  ]
};

const eGridDiv = document.querySelector('#myGrid');
new agGrid.Grid(eGridDiv, gridOptions);

Other packages similar to @ag-grid-community/core

react-table

react-table is a lightweight, fast, and extendable data grid built for React. It provides a simple API for creating tables with features like sorting, filtering, and pagination. Compared to @ag-grid-community/core, react-table is more lightweight and easier to integrate with React applications, but it may lack some of the advanced features and customizability of ag-Grid.

handsontable

handsontable is a JavaScript/HTML5 data grid component with Excel-like appearance and functionality. It supports features like data validation, sorting, filtering, and more. Compared to @ag-grid-community/core, handsontable offers a more Excel-like experience and is highly customizable, but it may have a steeper learning curve and higher complexity.

slickgrid

slickgrid is a JavaScript grid/spreadsheet component that provides high performance and a rich set of features. It supports large datasets, virtual rendering, and various grid functionalities. Compared to @ag-grid-community/core, slickgrid is known for its performance with large datasets, but it may require more effort to set up and customize.

README

ag-Grid

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 all major JavaScript frameworks. Here's how our grid looks like with multiple filters and grouping enabled:

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.

Looking for a framework specific solution?

• Get Started with AngularJS
• Get Started with Angular
• Get Started with React
• Get Started with Vue
• Get Started with WebComponents

Usage Overview

Install dependencies

$ npm i --save ag-grid

Add a placeholder to HTML

<div id="myGrid" style="height: 150px;width: 600px" class="ag-theme-balham"></div>

Import the grid and styles

import {Grid} from "@ag-grid-community/core";

import "@ag-grid-community/core/dist/styles/ag-grid.css";
import "@ag-grid-community/core/dist/styles/ag-theme-balham.css";

Set configuration

const gridOptions = {
	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: 'Boxter', price: 72000}
	]
};

Initialize the grid

let eGridDiv = document.querySelector('#myGrid');
new Grid(eGridDiv, this.gridOptions);

For more information on how to integrate the grid into your project see TypeScript - Building with Webpack 2.

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 [e-mail].

License

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