gp-grid-logo

Installation

Install the @gp-grid/react package, import the required stylesheet, and prepare your React project to render the high-performance gp-grid component today.

Package Manager

Install @gp-grid/react using your preferred package manager:

npm install @gp-grid/react

Requirements

  • React 18 or higher
  • TypeScript 5.0+ (recommended)

Peer Dependencies

The package has the following peer dependencies that should be installed automatically:

  • react >= 18.0.0
  • react-dom >= 18.0.0

TypeScript

gp-grid is written in TypeScript and includes built-in type definitions. No additional @types packages are required.

import { Grid, type ColumnDefinition, type GridProps } from "@gp-grid/react";

Styles

Starting from v0.11.0, gp-grid no longer auto-injects its CSS to avoid FUOC, this gives you the full flexibility of customizing gp-grid styles!.. You must import the stylesheet once in your application (e.g. in main.tsx, App.tsx, or your global CSS):

import "@gp-grid/react/dist/styles.css";

Or with standard CSS import:

@import "@gp-grid/react/dist/styles.css";

Next Steps

Once installed, check out the Basic Usage guide to create your first grid.