Per-package API Reference (auto-generated)
The full per-package API auto-generated from the TSDoc comments in the source code. For a curated getting-started summary, see the API Reference.
| Package | Description |
|---|---|
@topgrid/grid | Meta package — aggregates all @topgrid/grid-* packages (MIT + Pro facade) |
@topgrid/grid-core | TanStack Table abstraction wrapper + useGridState core hook |
@topgrid/grid-core-headless | Framework-agnostic grid core (table-core based). Shared by the React/Vue adapters. W1 Phase 0. |
@topgrid/grid-renderers | Cell renderers: Button, Badge, Check, Link, Number, Date, Icon |
@topgrid/grid-features | Column reorder, multi-sort, filter UI features |
@topgrid/grid-sizing | Declarative column sizing: auto-size, star/flex ratio widths, sizeToFit (pure + injectable measurement) |
@topgrid/grid-export | Excel, PDF, CSV export for grid data |
@topgrid/grid-vue | Vue 3 adapter (skeleton) — consumes the @topgrid/grid-core-headless shared core via @tanstack/vue-table. W1 Phase 0. Zero React dependency. |
@topgrid/grid-chart-core | Framework-neutral chart engine: labelled matrix → Apache ECharts option (no React/Vue; echarts type-only) |
@topgrid/grid-license | Pro license validation runtime |
@topgrid/grid-license-core | Framework-neutral license state + verification for TopGrid (no React/Vue). Source of the license singleton. |
@topgrid/grid-pro-agg | Pro: Aggregation (group footer) |
@topgrid/grid-pro-chart | Pro: Sparkline cells (zero-dep SVG) + injectable Range Chart panel |
@topgrid/grid-pro-chart-enterprise | Pro: Enterprise charting (Apache ECharts adapter) over the grid-pro-chart range/pivot bridge |
@topgrid/grid-pro-chart-enterprise-vue | Pro: Enterprise charting for Vue 3 (Apache ECharts) — reuses the framework-neutral @topgrid/grid-chart-core engine |
@topgrid/grid-pro-datamap | Pro: DataMap (foreign key display) |
@topgrid/grid-pro-edit-plus | Pro: editing productivity — declarative validation rules , undo/redo, find&replace, cell comments |
@topgrid/grid-pro-filter | Pro: Multi-condition (AND/OR) column filtering — compound FilterFn + 2-condition builder UI |
@topgrid/grid-pro-header | Pro: Multi-row Header (Column Groups) |
@topgrid/grid-pro-master | Pro: Master-Detail, TreeGrid, Context Menu |
@topgrid/grid-pro-merging | Pro: Cell Merging (rowSpan) — column.mergeRows API + automatic rowSpan calculation |
@topgrid/grid-pro-panel | Pro: declarative grid chrome — StatusBar, ToolPanel (column visibility/order), and a reused drag-grouping RowGroupPanel |
@topgrid/grid-pro-pivot | Pro: declarative 2-D pivot table (row × column dimensions × value aggregation) over <Grid> |
@topgrid/grid-pro-pivot-core | Framework-neutral pivot engine: declarative 2-D pivot transform + pure value reducers (no React/Vue). Consumed by @topgrid/grid-pro-pivot (React) and grid-pro-pivot-vue. |
@topgrid/grid-pro-pivot-vue | Pro: declarative 2-D pivot for Vue 3 — reuses the framework-neutral @topgrid/grid-pro-pivot-core engine (headless composable + tool panel). |
@topgrid/grid-pro-range | Pro: Cell Range Selection, Drag-fill, Clipboard |
@topgrid/grid-pro-serverside | Pro: server-side row model (SSRM) — block-based lazy loading, infinite scroll, server sort/filter/group with stale-response (epoch) rejection |
@topgrid/grid-pro-serverside-core | Framework-neutral server-side row model core: block cache, SSRM controller, lazy-group tree cache, viewport row model, server pivot columns (no React/Vue; @tanstack/table-core type-only). |
@topgrid/grid-pro-serverside-vue | Pro: server-side row model (SSRM) + viewport (push) row model for Vue 3 — reuses the framework-neutral @topgrid/grid-pro-serverside-core controllers. |
@topgrid/grid-pro-sheet | Pro: spreadsheet mode (PoC) — formula engine (A1 refs, SUM/AVERAGE/…), dependency-graph recalc with cycle detection |
@topgrid/grid-pro-tracking | Pro: ChangeTracking, Mapping, Validator |