API Overview (Vue)

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.

Grid Props

All props accepted by the Grid component

Column Definition

Configure individual columns

Data Sources

Client-side and server-side data handling

Exports

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

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

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

// Composables
import {
  useGridData,
  useGpGrid,
  useInputHandler,
  useAutoScroll,
  useFillHandle,
  useFilterPopup,
  useFilterConditions,
  useGridState,
} from "@gp-grid/vue";