@gp-grid/core 0.7.2 → 0.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/dist/index.d.ts +1 -2
- package/dist/index.js +11 -4154
- package/package.json +9 -9
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# gp-grid
|
|
1
|
+
# @gp-grid/core 🏁 🏎️
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
4
|
<a href="https://www.gp-grid.io">
|
|
@@ -31,12 +31,12 @@ A framework-agnostic TypeScript library for building high-performance data grids
|
|
|
31
31
|
|
|
32
32
|
## Available implementations
|
|
33
33
|
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
34
|
+
- [**@gp-grid/react**](https://www.npmjs.com/package/@gp-grid/react) | Official
|
|
35
|
+
- [**@gp-grid/vue**](https://www.npmjs.com/package/@gp-grid/vue) | Official
|
|
36
36
|
|
|
37
37
|
## Philosophy
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
**@gp-grid/core** is built on three core principles:
|
|
40
40
|
|
|
41
41
|
### 1. Slot-Based Virtual Scrolling
|
|
42
42
|
|
|
@@ -66,7 +66,7 @@ Data fetching is abstracted through a `DataSource` interface, supporting both:
|
|
|
66
66
|
npm/pnpm/yarn
|
|
67
67
|
|
|
68
68
|
```bash
|
|
69
|
-
pnpm add gp-grid
|
|
69
|
+
pnpm add @gp-grid/core
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
## Architecture Overview
|
|
@@ -81,7 +81,7 @@ The main orchestrator class that manages:
|
|
|
81
81
|
- Sort and filter state
|
|
82
82
|
|
|
83
83
|
```typescript
|
|
84
|
-
import { GridCore, createClientDataSource } from "gp-grid
|
|
84
|
+
import { GridCore, createClientDataSource } from "@gp-grid/core";
|
|
85
85
|
|
|
86
86
|
const dataSource = createClientDataSource(myData);
|
|
87
87
|
|
|
@@ -150,7 +150,7 @@ The core emits these instruction types:
|
|
|
150
150
|
For datasets that can be loaded entirely in memory. Sorting and filtering are performed client-side.
|
|
151
151
|
|
|
152
152
|
```typescript
|
|
153
|
-
import { createClientDataSource } from "gp-grid
|
|
153
|
+
import { createClientDataSource } from "@gp-grid/core";
|
|
154
154
|
|
|
155
155
|
interface Person {
|
|
156
156
|
id: number;
|
|
@@ -191,7 +191,7 @@ import {
|
|
|
191
191
|
createServerDataSource,
|
|
192
192
|
DataSourceRequest,
|
|
193
193
|
DataSourceResponse,
|
|
194
|
-
} from "gp-grid
|
|
194
|
+
} from "@gp-grid/core";
|
|
195
195
|
|
|
196
196
|
interface Person {
|
|
197
197
|
id: number;
|
|
@@ -310,7 +310,7 @@ interface HeaderRendererParams {
|
|
|
310
310
|
|
|
311
311
|
## Creating a Framework Adapter
|
|
312
312
|
|
|
313
|
-
To integrate gp-grid
|
|
313
|
+
To integrate @gp-grid/core with any UI framework:
|
|
314
314
|
|
|
315
315
|
1. **Subscribe to instructions** using `onBatchInstruction()`
|
|
316
316
|
2. **Maintain UI state** by processing instructions
|
|
@@ -320,7 +320,7 @@ To integrate gp-grid-core with any UI framework:
|
|
|
320
320
|
### Example: Minimal Adapter Pattern
|
|
321
321
|
|
|
322
322
|
```typescript
|
|
323
|
-
import { GridCore, GridInstruction } from "gp-grid
|
|
323
|
+
import { GridCore, GridInstruction } from "@gp-grid/core";
|
|
324
324
|
|
|
325
325
|
class MyGridAdapter {
|
|
326
326
|
private core: GridCore;
|
package/dist/index.d.ts
CHANGED
|
@@ -2063,5 +2063,4 @@ interface GridState<TData = Row> {
|
|
|
2063
2063
|
hoverPosition: CellPosition | null;
|
|
2064
2064
|
}
|
|
2065
2065
|
//#endregion
|
|
2066
|
-
export { type AssignSlotInstruction, type BatchInstructionListener, type CancelFillInstruction, type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type CloseFilterPopupInstruction, type ColumnDefinition, type ColumnFilterModel, type CommitEditInstruction, type CommitFillInstruction, type ContainerBounds, type CreateSlotInstruction, type DataChangeListener, type DataErrorInstruction, type DataLoadedInstruction, type DataLoadingInstruction, type DataSource, type DataSourceRequest, type DataSourceResponse, type DateFilterCondition, type DateFilterOperator, type DestroySlotInstruction, type Direction, type DragMoveResult, type DragState, EditManager, type EditManagerOptions, type EditRendererParams, type EditState, type FillHandleState, FillManager, type FilterCombination, type FilterCondition, type FilterModel, type FilterPopupState, GridCore, type GridCoreOptions, type GridInstruction, type GridState, type HeaderData, type HeaderRendererParams, type HighlightContext, HighlightManager, type HighlightingOptions, IndexedDataStore, type IndexedDataStoreOptions, InputHandler, type InputHandlerDeps, type InputResult, type InstructionListener, type KeyEventData, type KeyboardResult, type MoveSlotInstruction, type MultiColumnSortedChunk, type MutableClientDataSourceOptions, type MutableDataSource, type NumberFilterCondition, type NumberFilterOperator, type OpenFilterPopupInstruction, ParallelSortManager, type ParallelSortOptions, type PointerEventData, type Row, type RowId, type RowSortCache, type RowsAddedInstruction, type RowsRemovedInstruction, type RowsUpdatedInstruction, SelectionManager, type SelectionState, type SetActiveCellInstruction, type SetContentSizeInstruction, type SetHoverPositionInstruction, type SetSelectionRangeInstruction, type SlotData, type BatchInstructionListener$1 as SlotPoolBatchListener, SlotPoolManager, type SlotPoolManagerOptions, type SlotState, type SortDirection, type SortModel, type SortedChunk, type StartEditInstruction, type StartFillInstruction, type StopEditInstruction, type TextFilterCondition, type TextFilterOperator, type Transaction, TransactionManager, type TransactionManagerOptions, type TransactionProcessedInstruction, type TransactionResult, type UpdateFillInstruction, type UpdateHeaderInstruction, WorkerPool, type WorkerPoolOptions, buildCellClasses, calculateColumnPositions, calculateScaledColumnPositions, cellStyles, compareValues, computeValueHash, containerStyles, createClientDataSource, createDataSourceFromArray, createMutableClientDataSource, createServerDataSource, detectBoundaryCollisions, evaluateColumnFilter, evaluateDateCondition, evaluateNumberCondition, evaluateTextCondition, filtersStyles, findColumnAtX, getFieldValue, getTotalWidth, gridStyles, headerStyles, injectStyles, isCellActive, isCellEditing, isCellInFillPreview, isCellSelected, isColumnInSelectionRange, isRowInSelectionRange, isRowVisible, isSameDay, kWayMerge, kWayMergeMultiColumn, rowPassesFilter, scrollbarStyles, setFieldValue, statesStyles, stringToSortableNumber, variablesStyles };
|
|
2067
|
-
//# sourceMappingURL=index.d.ts.map
|
|
2066
|
+
export { type AssignSlotInstruction, type BatchInstructionListener, type CancelFillInstruction, type CellDataType, type CellPosition, type CellRange, type CellRendererParams, type CellValue, type CloseFilterPopupInstruction, type ColumnDefinition, type ColumnFilterModel, type CommitEditInstruction, type CommitFillInstruction, type ContainerBounds, type CreateSlotInstruction, type DataChangeListener, type DataErrorInstruction, type DataLoadedInstruction, type DataLoadingInstruction, type DataSource, type DataSourceRequest, type DataSourceResponse, type DateFilterCondition, type DateFilterOperator, type DestroySlotInstruction, type Direction, type DragMoveResult, type DragState, EditManager, type EditManagerOptions, type EditRendererParams, type EditState, type FillHandleState, FillManager, type FilterCombination, type FilterCondition, type FilterModel, type FilterPopupState, GridCore, type GridCoreOptions, type GridInstruction, type GridState, type HeaderData, type HeaderRendererParams, type HighlightContext, HighlightManager, type HighlightingOptions, IndexedDataStore, type IndexedDataStoreOptions, InputHandler, type InputHandlerDeps, type InputResult, type InstructionListener, type KeyEventData, type KeyboardResult, type MoveSlotInstruction, type MultiColumnSortedChunk, type MutableClientDataSourceOptions, type MutableDataSource, type NumberFilterCondition, type NumberFilterOperator, type OpenFilterPopupInstruction, ParallelSortManager, type ParallelSortOptions, type PointerEventData, type Row, type RowId, type RowSortCache, type RowsAddedInstruction, type RowsRemovedInstruction, type RowsUpdatedInstruction, SelectionManager, type SelectionState, type SetActiveCellInstruction, type SetContentSizeInstruction, type SetHoverPositionInstruction, type SetSelectionRangeInstruction, type SlotData, type BatchInstructionListener$1 as SlotPoolBatchListener, SlotPoolManager, type SlotPoolManagerOptions, type SlotState, type SortDirection, type SortModel, type SortedChunk, type StartEditInstruction, type StartFillInstruction, type StopEditInstruction, type TextFilterCondition, type TextFilterOperator, type Transaction, TransactionManager, type TransactionManagerOptions, type TransactionProcessedInstruction, type TransactionResult, type UpdateFillInstruction, type UpdateHeaderInstruction, WorkerPool, type WorkerPoolOptions, buildCellClasses, calculateColumnPositions, calculateScaledColumnPositions, cellStyles, compareValues, computeValueHash, containerStyles, createClientDataSource, createDataSourceFromArray, createMutableClientDataSource, createServerDataSource, detectBoundaryCollisions, evaluateColumnFilter, evaluateDateCondition, evaluateNumberCondition, evaluateTextCondition, filtersStyles, findColumnAtX, getFieldValue, getTotalWidth, gridStyles, headerStyles, injectStyles, isCellActive, isCellEditing, isCellInFillPreview, isCellSelected, isColumnInSelectionRange, isRowInSelectionRange, isRowVisible, isSameDay, kWayMerge, kWayMergeMultiColumn, rowPassesFilter, scrollbarStyles, setFieldValue, statesStyles, stringToSortableNumber, variablesStyles };
|