@gp-grid/vue 🏁 🏎️

Logo by camillo18tre ❤️

🎮 Demo • 📖 Documentation


A high-performance, feature lean Vue 3 data grid component built to manage grids with huge amount (millions) of rows. It's based on its core dependency: @gp-grid/core, featuring virtual scrolling, cell selection, sorting, filtering, editing, and Excel-like fill handle.

Table of Contents

- Features
- Installation
- Quick Start
- Examples
- API Reference
- Keyboard Shortcuts
- Styling
- Donations

Features

- Virtual Scrolling: Efficiently handles 150,000+ rows through slot-based recycling
- Cell Selection: Single cell, range selection, Shift+click extend, Ctrl+click toggle
- Multi-Column Sorting: Click to sort, Shift+click for multi-column sort
- Column Filtering: Built-in filter row with debounced input
- Cell Editing: Double-click or press Enter to edit, with custom editor support
- Fill Handle: Excel-like drag-to-fill for editable cells
- Keyboard Navigation: Arrow keys, Tab, Enter, Escape, Ctrl+A, Ctrl+C
- Custom Renderers: Registry-based cell, edit, and header renderers
- Dark Mode: Built-in dark theme support
- TypeScript: Full type safety with exported types

Installation

Use npm, yarn or pnpm

``bash
pnpm add @gp-grid/vue
`

Quick Start

`vue



`

Examples

$3

For larger datasets with client-side sort/filter operations:

`vue



`

$3

For datasets too large to load entirely in memory, use a server-side data source:

`vue



`

$3

Use the registry pattern to define reusable renderers:

`vue



`

$3

`vue



`

$3

`vue

`

API Reference

$3

| Prop | Type | Default | Description |
| ----------------- | ----------------------------------- | ----------- | ----------------------------------------------------------- |
| columns | ColumnDefinition[] | required | Column definitions |
| dataSource | DataSource | - | Data source for fetching data |
| rowData | TData[] | - | Alternative: raw data array (wrapped in client data source) |
| rowHeight | number | required | Height of each row in pixels |
| headerHeight | number | rowHeight | Height of header row |
| overscan | number | 3 | Number of rows to render outside viewport |
| sortingEnabled | boolean | true | Enable column sorting |
| darkMode | boolean | false | Enable dark theme |
| wheelDampening | number | 0.1 | Scroll wheel sensitivity (0-1) |
| cellRenderers | Record | {} | Cell renderer registry |
| editRenderers | Record | {} | Edit renderer registry |
| headerRenderers | Record | {} | Header renderer registry |
| cellRenderer | VueCellRenderer | - | Global fallback cell renderer |
| editRenderer | VueEditRenderer | - | Global fallback edit renderer |
| headerRenderer | VueHeaderRenderer | - | Global fallback header renderer |

$3

| Property | Type | Description |
| ---------------- | -------------- | ------------------------------------------------------------------- |
| field | string | Property path in row data (supports dot notation: "address.city") |
| colId | string | Unique column ID (defaults to field) |
| cellDataType | CellDataType | "text" \| "number" \| "boolean" \| "date" \| "object" |
| width | number | Column width in pixels |
| headerName | string | Display name in header (defaults to field) |
| editable | boolean | Enable cell editing |
| cellRenderer | string | Key in cellRenderers registry |
| editRenderer | string | Key in editRenderers registry |
| headerRenderer | string | Key in headerRenderers registry |

$3

`typescript
import type { VNode } from "vue";

// Cell renderer receives these params
interface CellRendererParams {
value: CellValue; // Current cell value
rowData: Row; // Full row data
column: ColumnDefinition; // Column definition
rowIndex: number; // Row index
colIndex: number; // Column index
isActive: boolean; // Is this the active cell?
isSelected: boolean; // Is this cell in selection?
isEditing: boolean; // Is this cell being edited?
}

// Vue cell renderer - can return VNode or string
type VueCellRenderer = (params: CellRendererParams) => VNode | string | null;

// Edit renderer receives additional callbacks
interface EditRendererParams extends CellRendererParams {
initialValue: CellValue;
onValueChange: (newValue: CellValue) => void;
onCommit: () => void;
onCancel: () => void;
}

// Vue edit renderer - returns VNode for edit input
type VueEditRenderer = (params: EditRendererParams) => VNode | null;

// Header renderer params
interface HeaderRendererParams {
column: ColumnDefinition;
colIndex: number;
sortDirection?: "asc" | "desc";
sortIndex?: number; // For multi-column sort
onSort: (direction: "asc" | "desc" | null, addToExisting: boolean) => void;
}

// Vue header renderer
type VueHeaderRenderer = (
params: HeaderRendererParams,
) => VNode | string | null;
`

Keyboard Shortcuts

| Key | Action |
| ------------------ | --------------------------------- |
| Arrow keys | Navigate between cells |
| Shift + Arrow | Extend selection |
| Enter | Start editing / Commit edit |
| Escape | Cancel edit / Clear selection |
| Tab | Commit and move right |
| Shift + Tab | Commit and move left |
| F2 | Start editing |
| Delete / Backspace | Start editing with empty value |
| Ctrl + A | Select all |
| Ctrl + C | Copy selection to clipboard |
| Any character | Start editing with that character |

Styling

The grid injects its own styles automatically. The main container uses these CSS classes:

- .gp-grid-container - Main container
- .gp-grid-container--dark - Dark mode modifier
- .gp-grid-header - Header row container
- .gp-grid-header-cell - Individual header cell
- .gp-grid-row - Row container
- .gp-grid-cell - Cell container
- .gp-grid-cell--active - Active cell
- .gp-grid-cell--selected - Selected cell
- .gp-grid-cell--editing - Cell in edit mode
- .gp-grid-filter-row - Filter row container
- .gp-grid-filter-input - Filter input field
- .gp-grid-fill-handle` - Fill handle element

Donations

Keeping this library requires effort and passion, I'm a full time engineer employed on other project and I'm trying my best to keep this work free! For all the features.

If you think this project helped you achieve your goals, it's hopefully worth a beer! 🍻