Package Exports

@ag-grid-community/react
@ag-grid-community/react/lib/main.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ag-grid-community/react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AG Grid React 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 React.

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/react

Import the grid and styles

import { AgGridReact } from '@ag-grid-community/react';

import '@ag-grid-community/styles/ag-grid.css';
import '@ag-grid-community/styles/ag-theme-quartz.css';

Set the grid's configuration in a parent component

class App extends Component {
    constructor(props) {
        super(props);

        this.state = {
            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 as the `AgGridReact` child component

class App extends Component {
    constructor(props) {...}

    render() {
        return (
            <div
                className="ag-theme-quartz"
                style={{
                    height: '500px',
                    width: '600px'
                }}
            >
                <AgGridReact
                    columnDefs={this.state.columnDefs}
                    rowData={this.state.rowData} />
            </div>
        );
    }
}

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 send your application to info@ag-grid.com.

License

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

@ag-grid-community/react