API Reference

Complete API documentation for gp-grid-react.

Grid Props

All props accepted by the Grid component

Column Definition

Configure individual columns

Data Sources

Client-side and server-side data handling

Events

Grid instructions and events

Exports

The gp-grid-react package exports the following:

// Component
import { Grid } from "gp-grid-react";

// Types
import type {
  GridProps,
  ColumnDefinition,
  CellDataType,
  CellValue,
  CellPosition,
  CellRange,
  SortDirection,
  SortModel,
  FilterModel,
  DataSource,
  DataSourceRequest,
  DataSourceResponse,
  MutableDataSource,
  CellRendererParams,
  EditRendererParams,
  HeaderRendererParams,
  ReactCellRenderer,
  ReactEditRenderer,
  ReactHeaderRenderer,
  GridInstruction,
} from "gp-grid-react";

// Data Source Factories
import {
  createClientDataSource,
  createDataSourceFromArray,
  createMutableClientDataSource,
  createServerDataSource,
} from "gp-grid-react";

API Overview