gp-grid-logo
API Reference

API Overview

Browse the full API reference for @gp-grid/angular with details on every component, input, output, and helper exported by the Angular integration package.

Complete API documentation for @gp-grid/angular.

The Angular component uses inputs and outputs for the shared core contracts. See guides for the cross-framework APIs and the migration guide for breaking changes.

Exports

// Component
import { GpGridComponent } from "@gp-grid/angular";

// Types
import type {
  AngularColumnDefinition,
  CellRendererTemplate,
  EditRendererTemplate,
  HeaderRendererTemplate,
  AngularFilterRenderer,
  FilterContentTemplate,
  FilterClearTemplate,
  ColumnDefinition,
  CellDataType,
  CellValue,
  CellPosition,
  CellRange,
  SortDirection,
  SortModel,
  FilterModel,
  ColumnFilterModel,
  ColumnFilterInput,
  FilterConditionGroup,
  GridLabelOverrides,
  DataSource,
  DataSourceRequest,
  DataSourceResponse,
  MutableDataSource,
  CellRendererParams,
  EditRendererParams,
  HeaderRendererParams,
  FilterRendererParams,
  FilterClearParams,
  HighlightingOptions,
} from "@gp-grid/angular";

// Data source factories
import {
  createClientDataSource,
  createDataSourceFromArray,
  createMutableClientDataSource,
  createServerDataSource,
} from "@gp-grid/angular";

// Grid data helpers
import {
  provideGridData,   // component providers for DI-based data
  injectGridData,    // typed inject() helper
  GridDataService,   // the underlying service
  createGridData,    // function-based alternative (no DI)
} from "@gp-grid/angular";

// Data options / API types
import type {
  GridDataOptions,
  GridDataApi,
} from "@gp-grid/angular";

// Filtering migration helper
import { normalizeColumnFilterModel } from "@gp-grid/angular";

// Stylesheet as a string (CSS-in-JS hosts, shadow roots)
import { gridStyles } from "@gp-grid/angular";