@ag-grid-community/client-side-row-model

32.3.5last stable release 4 days ago
Complexity Score
High
Open Issues
N/A
Dependent Projects
24
Weekly Downloadsglobal
318,437

Keywords

License

  • MIT
    • Yesattribution
    • Permissivelinking
    • Permissivedistribution
    • Permissivemodification
    • Nopatent grant
    • Yesprivate use
    • Permissivesublicensing
    • Notrademark grant

Downloads

Readme

JavaScript Data Grid | JavaScript Table

🌐 Website • 📖 Documentation • 🏘️ Community






AG Grid is a fully-featured and highly customizable JavaScript Data Grid. It delivers outstanding performance, has no third-party dependencies and comes with support for React, Angular and Vue.



📖 Overview

Table of Contents
  • [JavaScript Data Grid | JavaScript Table]
    • 📖 Overview
      • Features
      • Examples
    • ⚡️ Quick Start
      • Installation
      • Setup
      • Seed Projects
    • 🛠️ Customisations
      • Custom Components
      • Themes
      • Custom Themes
    • 🌍 Community
      • Tools & Extensions
      • Showcase
      • Stargazers
    • 🤝 Support
      • Enterprise Support
      • Bug Reports
      • Questions
      • Contributing
    • ⚠️ License

AG Grid is available in two versions: Community & Enterprise.

  • ag-grid-community is free, available under the MIT license, and comes with all of the core features expected from a JavaScript Data Grid, including Sorting, Filtering, Pagination, Editing, Custom Components, Theming and more.
  • ag-grid-enterprise is available under a commercial license and comes with advanced features, like Integrated Charting, Row Grouping, Aggregation, Pivoting, Master/Detail, Server-side Row Model, and Exporting in addition to dedicated support from our Engineering team.

Features

Feature AG Grid Community AG Grid Enterprise Filtering ✅ ✅ (Advanced) Sorting ✅ ✅ Cell Editing ✅ ✅ CSV Export ✅ ✅ Drag & Drop ✅ ✅ Themes and Styling ✅ ✅ Selection ✅ ✅ Accessibility ✅ ✅ Infinite Scrolling ✅ ✅ Pagination ✅ ✅ Server-Side Data ✅ ✅ (Advanced) Custom Components ✅ ✅ Integrated Charting ❌ ✅ Range Selection ❌ ✅ Row Grouping and Aggregation ❌ ✅ Pivoting ❌ ✅ Excel Export ❌ ✅ Clipboard Operations ❌ ✅ Master/Detail ❌ ✅ Tree Data ❌ ✅ Column Menu ❌ ✅ Context Menu ❌ ✅ Tool Panels ❌ ✅ Support ❌ ✅

ℹ️ Note:

Visit the Pricing page for a full comparison.

Examples

We’ve created several demos to showcase AG Grid’s rich feature set across different use cases. See them in action below, or interact with them on our Demo page.

🏦 Financial Demo

Financial data example featuring live updates and sparklines:


Live Demo • Source Code
📦 Inventory Demo

Inventory data example to view and manage products:

Live Demo • Source Code
🧑‍💼 HR Demo

HR data example showing hierarchical employee data:

Live Demo • Source Code

⚡️ Quick Start

AG Grid is easy to set up - all you need to do is provide your data and define your column structure. Read on for vanilla JavaScript installation instructions, or refer to our framework-specific guides for React, Angular and Vue.

Installation

$ npm install --save ag-grid-community

Setup

1. Provide a Container

Load the AG Grid library and create a container div. The div should have a height because the Data Grid will fill the size of the parent container:

<html lang="en">
    <head>
        <!-- Includes all JS & CSS for the JavaScript Data Grid -->
        <script src="https://cdn.jsdelivr.net/npm/ag-grid-community/dist/ag-grid-community.min.js"></script>
    </head>
    <body>
        <!-- Your Data Grid container -->
        <div id="myGrid" style="height: 500px"></div>
    </body>
</html>

2. Instantiating the JavaScript Data Grid

Create the Data Grid inside of your container div using createGrid.

// Grid Options: Contains all of the Data Grid configurations
const gridOptions = {};

// Your Javascript code to create the Data Grid
const myGridElement = document.querySelector('#myGrid');
agGrid.createGrid(myGridElement, gridOptions);

3. Define Rows and Columns

// Grid Options: Contains all of the Data Grid configurations
const gridOptions = {
    // Row Data: The data to be displayed.
    rowData: [
        { make: 'Tesla', model: 'Model Y', price: 64950, electric: true },
        { make: 'Ford', model: 'F-Series', price: 33850, electric: false },
        { make: 'Toyota', model: 'Corolla', price: 29600, electric: false },
    ],
    // Column Definitions: Defines the columns to be displayed.
    columnDefs: [{ field: 'make' }, { field: 'model' }, { field: 'price' }, { field: 'electric' }],
};

ℹ️ Note:

For more information on building Data Grids with AG Grid, refer to our Documentation.

Seed Projects

We also provide Seed Projects to help you get started with common configurations:

Environment Framework Create React App (CRA) Vite Create Next App Vite - TypeScript Webpack 5 - TypeScript Webpack 5 - JavaScript Angular CLI Nuxt Vite

🛠️ Customisations

AG Grid is fully customisable, both in terms of appearance and functionality. There are many ways in which the grid can be customised and we provide a selection of tools to help create those customisations.

Custom Components

You can create your own Custom Components to customise the behaviour of the grid. For example, you can customise how cells are rendered, how values are edited and also create your own filters.

There are a number of different Component Types that you can provide to the grid, including:

  • Cell Component: To customise the contents of a cell.
  • Header Component: To customise the header of a column and column groups.
  • Edit Component: To customise the editing of a cell.
  • Filter Component: For custom column filter that appears inside the column menu.
  • Floating Filter: For custom column floating filter that appears inside the column menu.
  • Date Component: To customise the date selection component in the date filter.
  • Loading Component: To customise the loading cell row when using Server Side Row Model.
  • Overlay Component: To customise loading and no rows overlay components.
  • Status Bar Component: For custom status bar components.
  • Tool Panel Component: For custom tool panel components.
  • Tooltip Component: For custom cell tooltip components.
  • Menu Item Component: To customise the menu items shown in the Column and Context Menus.

To supply a custom cell renderer and filter components to the Grid, create a direct reference to your component within the gridOptions.columnDefs property:

gridOptions = {
    columnDefs: [
        {
            field: 'country', // The column to add the component to
            cellRenderer: CountryCellRenderer, // Your custom cell component
            filter: CountryFilter, // Your custom filter component
        },
    ],
};

Themes

AG Grid has 4 themes, each available in light & dark modes:

Quartz Material Alpine Balham

Custom Themes

All AG Grid themes can be customised using the Theming API, or you can create a new theme from scratch with the help of our Theme Builder or Figma Design System.

🌍 Community

Tools & Extensions

AG Grid has a large and active community who have created an ecosystem of 3rd party tools, extensions and utilities to help you build your next project with AG Grid, no matter which language or framework you use:

 React •  Angular •  TypeScript •  Vue •  Python •  Svelte •  SolidJS •  .NET •  Rust •  Laravel

Showcase

AG Grid is used by 100,000’s of developers across the world, from almost every industry. Whilst most of these projects are private, we’ve curated a selection of open-source projects from different industries where household names use AG Grid, including J.P.Morgan, MongoDB and NASA. Visit our Community Showcase page to learn more.

Stargazers

Founded in 2016, AG Grid has seen a steady rise in popularity and is now the market leader for Data Grids:

🤝 Support

Enterprise Support

AG Grid Enterprise customers have access to dedicated support via ZenDesk, which is monitored by our engineering teams.

Bug Reports

If you have found a bug, please report it in this repository’s issues section.

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

ag-grid-community is licensed under the MIT license.

ag-grid-enterprise has a Commercial license.

See the LICENSE file for more info.

AG Charts

If you’ve made it this far, you may be interested in our latest project: AG Charts - The best JavaScript Charting library in the world.

Initially built to power Integrated Charts in AG Grid, we open-sourced this project in 2018. Having seen the steady rise in popularity since then, we have decided to invest in AG Charts with a dedicated Enterprise version (ag-charts-enterprise) in addition to our continued support of ag-charts-community.


Follow us to keep up to date with all the latest news from AG Grid:

Dependencies

No runtime dependency information found for this package.

CVE IssuesActive
0
Scorecards Score
3.70
Test Coverage
No Data
Follows Semver
Yes
Github Stars
13,740
Dependenciestotal
5
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No Data
Repo Audits
No Data

Learn how to distribute @ag-grid-community/client-side-row-model in your own private NPM registry

npm config set registry  https://npm.cloudsmith.com/owner/repo
Processing...
Done
npm install @ag-grid-community/client-side-row-model
Processing...
Done
Start your free trial

78 Releases

NPM on Cloudsmith

Getting started with NPM on Cloudsmith is fast and easy.

Learn more about NPM on Cloudsmith
View the Docs