gp-grid-logo
API Reference

API Overview

Browse the full API reference for @gp-grid/vue with details on every component, prop, emit, slot, and helper exported by the Vue 3 integration package.

Complete API documentation for @gp-grid/vue.

Exports

// Component
import { GpGrid } from "@gp-grid/vue";
// or
import GpGrid from "@gp-grid/vue";

// Types
import type {
  GpGridProps,
  ColumnDefinition,
  CellDataType,
  CellValue,
  CellPosition,
  CellRange,
  SortDirection,
  SortModel,
  FilterModel,
  ColumnFilterModel,
  ColumnFilterInput,
  FilterConditionGroup,
  GridLabelOverrides,
  DataSource,
  DataSourceRequest,
  DataSourceResponse,
  MutableDataSource,
  CellRendererParams,
  EditRendererParams,
  HeaderRendererParams,
  VueCellRenderer,
  VueEditRenderer,
  VueHeaderRenderer,
  FilterRendererParams,
  FilterClearParams,
  VueFilterRenderer,
  VueFilterContentRenderer,
  VueFilterClearRenderer,
  UseGridDataOptions,
  UseGridDataResult,
} from "@gp-grid/vue";

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

// Composables
import {
  useGridData,
  useGpGrid,
  useRowGroupCellContext,
  useRowGroupingSync,
} from "@gp-grid/vue";

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

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