API Reference
API Overview
Browse the full API reference for @gp-grid/react with details on every component, prop, event, and helper exported by the React integration package today.
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,
GridRef,
ColumnDefinition,
CellDataType,
CellValue,
CellPosition,
CellRange,
SortDirection,
SortModel,
FilterModel,
ColumnFilterModel,
ColumnFilterInput,
FilterConditionGroup,
GridLabelOverrides,
DataSource,
DataSourceRequest,
DataSourceResponse,
MutableDataSource,
CellRendererParams,
EditRendererParams,
HeaderRendererParams,
ReactCellRenderer,
ReactEditRenderer,
ReactHeaderRenderer,
FilterRendererParams,
FilterClearParams,
ReactFilterRenderer,
ReactFilterContentRenderer,
ReactFilterClearRenderer,
GridInstruction,
UseGridDataOptions,
UseGridDataResult,
} from "@gp-grid/react";
// Data Source Factories
import {
createClientDataSource,
createDataSourceFromArray,
createMutableClientDataSource,
createServerDataSource,
} from "@gp-grid/react";
// Hooks
import { useGridData } from "@gp-grid/react";
// Filtering migration helper
import { normalizeColumnFilterModel } from "@gp-grid/react";
// Stylesheet as a string (CSS-in-JS hosts, shadow roots)
import { gridStyles } from "@gp-grid/react";