@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. · Free (MIT)
This page is auto-generated from TSDoc comments in the source code (internal markers scrubbed). For a curated getting-started summary, see the API Reference.
17 public exports — 11 functions · 0 hooks · 0 components · 5 types · 1 constants.
Functions
cellValueToClipboardText
Cell value → clipboard text (pure, W1 Phase 0, ported from grid-pro-master).
A value→text mapping decoupled from the browser navigator.clipboard wiring. framework-agnostic —
shared by the React copy (makeCopyCellItem) and Vue copy adapters.
Mapping: null/undefined→'' (empty string, not "null"/"undefined") · object (including arrays)→JSON.stringify · otherwise (string/number/boolean)→String.
cellValueToClipboardText(cell: { … }): string
createVueCheckboxColumn
createVueCheckboxColumn(): CreateSelectionColumn<TData>
dateRangeFilterFn
dateRangeFilterFn(row: Row<unknown>, columnId: string, filterValue: any, addMeta: (…) => …): boolean
fillRange
fillRange(sourceRange: CellRange, direction: FillDirection, fillCount: number, getCellValue: (…) => …): CellUpdate<TCell>[]
isInRange
isInRange(row: number, col: number, range: null | CellRange): boolean
normalizeRange
normalizeRange(range: CellRange): CellRange
numberFilterFn
numberFilterFn(row: Row<unknown>, columnId: string, filterValue: any, addMeta: (…) => …): boolean
parseTsv
parseTsv(tsv: string): string[][]
selectFilterFn
selectFilterFn(row: Row<any>, columnId: string, filterValue: any, addMeta: (…) => …): boolean
stringifyTsv
stringifyTsv(matrix: readonly readonly unknown[][]): string
textFilterFn
textFilterFn(row: Row<unknown>, columnId: string, filterValue: any, addMeta: (…) => …): boolean
Types & Interfaces
CellCoord
Pure cell range utilities — normalization · containment check · drag-fill · TSV (W1 Phase 0, ported from grid-pro-range).
All are framework-agnostic pure functions + pure data types (coordinate/rectangle/direction/update). The React (grid-pro-range) and Vue range adapters share the same math/serialization. Render/event-agnostic.
| Property | Type | Description |
|---|---|---|
col | number | |
row | number |
CellRange
| Property | Type | Description |
|---|---|---|
end | CellCoord | |
start | CellCoord |
DateFilterValue
| Property | Type | Description |
|---|---|---|
from? | Date | |
to? | Date |
NumberFilterValue
| Property | Type | Description |
|---|---|---|
max? | number | |
min? | number | |
operator | NumberFilterOperator | |
value? | number |
TextFilterValue
| Property | Type | Description |
|---|---|---|
operator | TextFilterOperator | |
value | string |
Constants
Grid
const Grid: DefineComponent<ExtractPropTypes<{ … }>, (…) => …, object, object, object, ComponentOptionsMixin, ComponentOptionsMixin, object, string, PublicProps, ToResolvedProps<ExtractPropTypes<{ … }>, object>, { … }, object, object, object, string, ComponentProvideOptions, true, object, any>