AG Grid Guide for React

Introduction to AG Grid and Its Capabilities

AG Grid is a powerful JavaScript library that provides a robust grid component for both displaying and manipulating data in web applications. One of the key strengths of AG Grid lies in its high performance, which is achieved through techniques like virtualization of columns and rows. This ensures smooth scrolling and interaction, even with large datasets. This performance makes it a prime choice for developers looking to enhance their web applications with advanced data manipulation capabilities.

Another significant advantage of AG Grid is its extensibility. While it comes with a comprehensive set of features out of the box, it also allows for extensive customization. Developers can create custom components for cell rendering, editing, and filtering, making it adaptable to a wide range of use cases. The ergonomic API further simplifies the process of integrating AG Grid into applications.

Setting Up AG Grid in a React Application

Getting started with AG Grid in a React application is straightforward. To install AG Grid, you need to add two packages: ag-grid-community and ag-grid-react. These can be installed using npm and added to your package.json file. Once installed, you also need to set up the necessary CSS for styling, which involves importing base and theme CSS files from the ag-grid-community package.

After the initial setup, defining how your data is displayed is crucial. AG Grid requires you to define columns, including their sorting and filtering behaviors. This is done through column definitions, which determine how data is presented in the grid. The simplest form of a column definition specifies the header name and the field from which data is fetched.

Defining Columns and Styling in AG Grid

Column definitions in AG Grid are essential for controlling how data is visualized. Each column is defined by an object known as ColDef, which can be customized using various properties. For instance, you can define sorting behavior, filtering options, and even custom styling for each column.

AG Grid allows for the use of themes and custom styling to ensure the grid aligns with the design of your application. You can import different themes and customize them as needed. The Alpine theme, for example, is a popular choice for its modern look. Custom styling can be achieved by importing CSS files and applying them to the grid.

Working with Row Data and Models

Row data in AG Grid can be managed using different models. The client-side row model is the most common, where all data is maintained on the client and displayed by AG Grid. This is ideal for smaller datasets that can be fully loaded in the browser.

For larger datasets, AG Grid offers infinite scrolling and server-side row models. Infinite scrolling allows data to be loaded in chunks as the user scrolls, similar to social media feeds. The server-side row model, available in the enterprise version, fetches data directly from the server, making it suitable for applications with extensive data requirements.

Enhancing User Interaction with Sorting and Filtering

Sorting and filtering are critical features for interactive data grids. AG Grid allows for multi-column sorting, where users can sort by multiple columns simultaneously. This is achieved by holding a modifier key (such as shift) and clicking on the column headers. You can also customize the sorting order to suit your application's needs.

Filtering in AG Grid can be enabled by setting the filter property in column definitions. AG Grid provides several built-in filters, including text, number, and date filters. These can be customized further with comparator functions, allowing for complex filtering logic based on your data structure.

Rendering and Editing Data with AG Grid

Rendering data in AG Grid can be customized using value getters, value formatters, and cell renderers. Value getters allow you to compute values for cells dynamically, while value formatters enable you to format these values for display. Cell renderers offer the most flexibility, allowing you to define custom rendering logic using React components.

Editing data is equally flexible. AG Grid provides built-in editors for text, dates, and select fields, but you can also create custom editors using React components. This is particularly useful for creating complex or interactive editing experiences, such as color pickers or custom input fields.

Persisting and Managing Data Changes

Data persistence in AG Grid can be managed in several ways. By default, AG Grid mutates the data bound to it, which may not always be desirable. Instead, you can use events like onCellEditRequest to handle data changes manually, ensuring that changes are persisted in a way that aligns with your application's architecture.

For applications that require immutability, AG Grid can be configured in read-only mode. This mode prevents AG Grid from mutating the data directly, allowing you to handle data updates through events and API calls, ensuring a consistent state management approach.

Styling AG Grid: Cells, Rows, and Themes

Styling in AG Grid is highly customizable, allowing you to apply both global and conditional styles to cells and rows. You can use CSS classes and inline styles to achieve this. AG Grid also supports cell class rules and row class rules, which enable you to conditionally apply styles based on data values or other criteria.

Themes are another aspect of styling, with AG Grid offering several built-in themes like Alpine and Balham. These themes can be customized using CSS variables and Sass mixins, allowing you to tailor the look and feel of the grid to match your application's design language.

Conclusion

AG Grid is a versatile and powerful grid solution for React applications, offering extensive customization options for both data presentation and user interaction. Its high performance and flexibility make it suitable for a wide range of use cases, from simple data displays to complex, interactive data manipulation tools. By leveraging the features of AG Grid, developers can create rich, engaging web applications that provide a seamless user experience.

Watch full talk with demos and examples:

Rate this content
Bookmark

From Author:

Does your React app need to efficiently display lots (and lots) of data in a grid? Do your users want to be able to search, sort, filter, and edit data? AG Grid is the best JavaScript grid in the world and is packed with features, highly performant, and extensible. In this workshop, you’ll learn how to get started with AG Grid, how we can enable sorting and filtering of data in the grid, cell rendering, and more. You will walk away from this free 3-hour workshop equipped with the knowledge for implementing AG Grid into your React application.


We all know that rolling our own grid solution is not easy, and let's be honest, is not something that we should be working on. We are focused on building a product and driving forward innovation. In this workshop, you'll see just how easy it is to get started with AG Grid.


Prerequisites: 

Basic React and JavaScript


Workshop level:

Beginner

This workshop has been presented at React Advanced 2022, check out the latest edition of this React Conference.

FAQ

To enable cell editing in AG Grid, set the 'editable' property to true in the column definition. For example, use 'editable: true' to make a column editable. Additionally, you can specify a cell editor like 'AG large text cell editor' for a custom editing experience.

To customize AG Grid themes, you can override global CSS styles, use theme parameters, CSS variables, or SASS mixins and functions. Start with a pre-built theme such as Alpine or Material and customize it using CSS variables for properties like background color, foreground color, and border color.

AG Grid provides several built-in cell editors including the text cell editor, large text cell editor, date editor, and select editor. For more advanced options, the enterprise version offers a rich select editor.

Yes, you can apply conditional styles to cells in AG Grid using the 'cellClassRules' property in the column definition. This property allows you to add and remove CSS classes based on specific conditions defined in a callback function.

The recommended method to update cell values in AG Grid is by using the 'valueSetter' function. This function allows you to specify how cell values should be updated and can return true or false to indicate if the update should trigger a cell refresh.

To customize row styles in AG Grid, use the 'rowStyle', 'getRowStyle', 'rowClass', 'getRowClass', and 'rowClassRules' properties on the AG Grid React component. These allow you to apply inline styles, CSS classes, and conditional class rules to rows.

To handle data persistence after cell editing in AG Grid, you can use the 'onCellValueChanged' event to capture changes and update your data source. For immutable data handling, use the 'onCellEditRequest' event in read-only mode and update the data manually.

Brian Love
Brian Love
140 min
11 Oct, 2022

Comments

Sign in or register to post your comment.
Video Summary and Transcription
This workshop is about AG Grid, a JavaScript grid with great performance and an ergonomic API. It covers installation, column definitions, row data, sorting, filtering, cell rendering, editing, and styling. The workshop includes exercises to practice hands-on coding. It also explores advanced topics such as value getters, formatters, cell renderers, and custom cell editors. Additionally, it covers persisting data, handling cell value changes, and styling cells and rows using cell classes, styles, and themes.

1. Introduction to Workshop

Welcome to the workshop! Today we're learning about HP Grid as part of the React Advanced Conference. I'm Bryan Love, co-founder of Live Love App, and I'm joined by Mike Ryan. We're both Google Developer Experts and Cypress Ambassadors. We'll be taking breaks every hour during this three-hour workshop. Feel free to ask any questions you may have.
Read also

2. Introduction to AG Grid Workshop

The prereqs for this workshop are JavaScript and TypeScript, and basic React. AG Grid is the best JavaScript grid with great performance, extensibility, and an ergonomic API. We'll be using the AG Grid with React course on our website. All course content and exercises are available online using StackBlitz. We'll cover installation, column definitions, row data, sorting, filtering, cell rendering, editing, and styling of AG Grid.

Watch more workshops on topic

React Performance Debugging Masterclass
React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Top Content
Featured WorkshopFree
Ivan Akulov
Ivan Akulov
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
Concurrent Rendering Adventures in React 18
React Advanced 2021React Advanced 2021
132 min
Concurrent Rendering Adventures in React 18
Top Content
Featured WorkshopFree
Maurice de Beijer
Maurice de Beijer
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Hooks Tips Only the Pros Know
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Top Content
Featured Workshop
Maurice de Beijer
Maurice de Beijer
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React, TypeScript, and TDD
React Advanced 2021React Advanced 2021
174 min
React, TypeScript, and TDD
Top Content
Featured WorkshopFree
Paul Everitt
Paul Everitt
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
Web3 Workshop - Building Your First Dapp
React Advanced 2021React Advanced 2021
145 min
Web3 Workshop - Building Your First Dapp
Top Content
Featured WorkshopFree
Nader Dabit
Nader Dabit
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
Designing Effective Tests With React Testing Library
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Top Content
Featured Workshop
Josh Justice
Josh Justice
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

A Guide to React Rendering Behavior
React Advanced 2022React Advanced 2022
25 min
A Guide to React Rendering Behavior
Top Content
This transcription provides a brief guide to React rendering behavior. It explains the process of rendering, comparing new and old elements, and the importance of pure rendering without side effects. It also covers topics such as batching and double rendering, optimizing rendering and using context and Redux in React. Overall, it offers valuable insights for developers looking to understand and optimize React rendering.
Building Better Websites with Remix
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Top Content
Remix is a web framework built on React Router that focuses on web fundamentals, accessibility, performance, and flexibility. It delivers real HTML and SEO benefits, and allows for automatic updating of meta tags and styles. It provides features like login functionality, session management, and error handling. Remix is a server-rendered framework that can enhance sites with JavaScript but doesn't require it for basic functionality. It aims to create quality HTML-driven documents and is flexible for use with different web technologies and stacks.
Scaling Up with Remix and Micro Frontends
Remix Conf Europe 2022Remix Conf Europe 2022
23 min
Scaling Up with Remix and Micro Frontends
Top Content
This talk discusses the usage of Microfrontends in Remix and introduces the Tiny Frontend library. Kazoo, a used car buying platform, follows a domain-driven design approach and encountered issues with granular slicing. Tiny Frontend aims to solve the slicing problem and promotes type safety and compatibility of shared dependencies. The speaker demonstrates how Tiny Frontend works with server-side rendering and how Remix can consume and update components without redeploying the app. The talk also explores the usage of micro frontends and the future support for Webpack Module Federation in Remix.
React Compiler - Understanding Idiomatic React (React Forget)
React Advanced 2023React Advanced 2023
33 min
React Compiler - Understanding Idiomatic React (React Forget)
Top Content
Watch video: React Compiler - Understanding Idiomatic React (React Forget)
Joe Savona
Mofei Zhang
2 authors
The Talk discusses React Forget, a compiler built at Meta that aims to optimize client-side React development. It explores the use of memoization to improve performance and the vision of Forget to automatically determine dependencies at build time. Forget is named with an F-word pun and has the potential to optimize server builds and enable dead code elimination. The team plans to make Forget open-source and is focused on ensuring its quality before release.
Using useEffect Effectively
React Advanced 2022React Advanced 2022
30 min
Using useEffect Effectively
Top Content
Today's Talk explores the use of the useEffect hook in React development, covering topics such as fetching data, handling race conditions and cleanup, and optimizing performance. It also discusses the correct use of useEffect in React 18, the distinction between Activity Effects and Action Effects, and the potential misuse of useEffect. The Talk highlights the benefits of using useQuery or SWR for data fetching, the problems with using useEffect for initializing global singletons, and the use of state machines for handling effects. The speaker also recommends exploring the beta React docs and using tools like the stately.ai editor for visualizing state machines.
Routing in React 18 and Beyond
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Top Content
Routing in React 18 brings a native app-like user experience and allows applications to transition between different environments. React Router and Next.js have different approaches to routing, with React Router using component-based routing and Next.js using file system-based routing. React server components provide the primitives to address the disadvantages of multipage applications while maintaining the same user experience. Improving navigation and routing in React involves including loading UI, pre-rendering parts of the screen, and using server components for more performant experiences. Next.js and Remix are moving towards a converging solution by combining component-based routing with file system routing.