ag-grid-react
    TypeScript icon, indicating that this package has built-in type declarations

    26.2.0 • Public • Published

    alt text

    CDNJS npm Bundle Phobia Github Stars Twitter

    AG Grid React 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 i --save ag-grid-community ag-grid-react react-dom-factories
    

    Import the grid and styles

    import {AgGridReact} from 'ag-grid-react';
    
    import 'ag-grid-community/dist/styles/ag-grid.css';
    import 'ag-grid-community/dist/styles/ag-theme-balham.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: "Boxter", price: 72000}
    			]
    		}
    	}
    	...
    }
    

    Render the grid as the AgGridReact child component

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

    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.

    Install

    npm i ag-grid-react

    DownloadsWeekly Downloads

    135,311

    Version

    26.2.0

    License

    MIT

    Unpacked Size

    304 kB

    Total Files

    84

    Last publish

    Collaborators

    • ceolter
    • seanlandsman
    • alberto.gutierrez
    • rmc.software