@infinite-table/infinite-vue 0.0.1 → 9.1.5

package/README.md

@@ -21,6 +21,7 @@
 - [🤔 What is Infinite Table?](#-what-is-infinite-table)
 - [📦 Installation](#-installation)
 - [📄 Extensive documentation](#-extensive-documentation)
+- [⚖️ Compare](#-compare)
 - [❤️ TypeScript](#-typescript)
 - [🏢 Enterprise-ready](#-enterprise-ready)
   - [🔒 Secure by default](#-secure-by-default)
@@ -76,6 +77,15 @@ Our approach with the `InfiniteTable` is to go documentation first. From our dev
 
 **[Visit our docs and getting-started guide](https://infinite-table.com/docs)**
 
+## ⚖️ Compare
+
+Choosing a React DataGrid is a big decision. We've put together honest comparisons so you can see where Infinite Table fits — particularly if you value a component that feels native to React (hooks, controlled/uncontrolled props).
+
+- [Overview](https://infinite-table.com/docs/learn/compare)
+- [vs AG Grid](https://infinite-table.com/docs/learn/compare/ag-grid)
+- [vs TanStack Table](https://infinite-table.com/docs/learn/compare/tanstack-table)
+- [vs MUI X Data Grid](https://infinite-table.com/docs/learn/compare/mui-x-data-grid)
+
 ## ❤️ TypeScript
 
 It's fully typed and offers you great developer experience to help you get up and running quickly

package/index.d.ts

@@ -368,14 +368,38 @@ interface PerfMarker {
     }): PerfMarker;
 }
 
+type RowInfoStoreNotifyParams<T> = {
+    marker?: PerfMarker;
+    /**
+     * The DataSource state that produced `newDataArray` and the state it replaces.
+     * Exposed to cells via `getDataSourceStates()` so `repaintCellsKey` functions
+     * can compare the two.
+     */
+    dataSourceState?: DataSourceState<T>;
+    previousDataSourceState?: DataSourceState<T>;
+};
+type RowInfoStoreDataSourceStates<T> = {
+    dataSourceState: DataSourceState<T> | undefined;
+    previousDataSourceState: DataSourceState<T> | undefined;
+};
 interface RowInfoStore<T> {
     /**
      * Update the entire dataArray (called from reducer)
      * Compares old vs new rowInfo at each index and notifies subscribers for changed indices
      */
-    notifyDataArray(newDataArray: InfiniteTableRowInfo<T>[], params?: {
-        marker?: PerfMarker;
-    }): void;
+    notifyDataArray(newDataArray: InfiniteTableRowInfo<T>[], params?: RowInfoStoreNotifyParams<T>): void;
+    /**
+     * Subscribe to *any* change of the dataArray reference (regardless of which
+     * rows changed). Used by cells whose `repaintCellsKey` is a function, so they
+     * can re-evaluate their key after every data change.
+     * Returns unsubscribe function
+     */
+    subscribeToDataArrayChange(callback: () => void): () => void;
+    /**
+     * The DataSource state that produced the current dataArray, and the one
+     * before it - as passed by the reducer via `notifyDataArray`.
+     */
+    getDataSourceStates(): RowInfoStoreDataSourceStates<T>;
     /**
      * Get current rowInfo at index (snapshot for useSyncExternalStore)
      */
@@ -1204,6 +1228,12 @@ type InfiniteTableColumn<DATA_TYPE> = {
     headerStyle?: InfiniteTableColumnHeaderStyle<DATA_TYPE>;
     headerClassName?: InfiniteTableColumnHeaderClassName<DATA_TYPE>;
     className?: InfiniteTableColumnClassName<DATA_TYPE>;
+    /**
+     * Forces the cells of this column to re-render when their row didn't change
+     * but something they render depends on did (eg: cross-row computations).
+     * Takes precedence over the `repaintCellsKey` prop of the table.
+     */
+    repaintCellsKey?: InfiniteTablePropRepaintCellsKey<DATA_TYPE>;
     rowspan?: InfiniteTableColumnRowspanFn<DATA_TYPE>;
     render?: InfiniteTableColumnRenderFunction<DATA_TYPE>;
     renderValue?: InfiniteTableColumnRenderFunction<DATA_TYPE>;
@@ -1934,6 +1964,31 @@ type InfiniteTableRowClassNameFn<T> = (params: InfiniteTableRowStylingFnParams<T
 type InfiniteTableCellClassNameFn<T> = InfiniteTableColumn<T>['className'];
 type InfiniteTablePropRowStyle<T> = React$1.CSSProperties | InfiniteTableRowStyleFn<T>;
 type InfiniteTablePropCellStyle<T> = InfiniteTableColumn<T>['style'];
+type InfiniteTablePropRepaintCellsKeyFnParams<T> = {
+    rowInfo: InfiniteTableRowInfo<T>;
+    column: InfiniteTableComputedColumn<T>;
+    /**
+     * The DataSource state that produced the current data array.
+     */
+    dataSourceState: DataSourceState<T>;
+    /**
+     * The DataSource state before the last data change - `undefined` until the
+     * first data change happens.
+     */
+    previousDataSourceState: DataSourceState<T> | undefined;
+};
+/**
+ * Called for each cell (whenever the DataSource data array changes) - the cell
+ * is re-rendered when the returned key is different (via `Object.is`) from the
+ * key returned on the previous call. Return primitives or stable references.
+ */
+type InfiniteTablePropRepaintCellsKeyFn<T> = (params: InfiniteTablePropRepaintCellsKeyFnParams<T>) => unknown;
+/**
+ * When a string/number/object - cells re-render whenever the key changes.
+ * When a function - it is called per cell after each data change and the cell
+ * re-renders when the returned key changes.
+ */
+type InfiniteTablePropRepaintCellsKey<T> = string | number | object | InfiniteTablePropRepaintCellsKeyFn<T>;
 type InfiniteTablePropRowClassName<T> = string | InfiniteTableRowClassNameFn<T>;
 type InfiniteTablePropCellClassName<T> = string | InfiniteTableCellClassNameFn<T>;
 type InfiniteTableColumnAggregator<T, AggregationResultType> = Omit<AggregationReducer<T, AggregationResultType>, 'getter' | 'id'> & {
@@ -2338,6 +2393,12 @@ interface InfiniteTableProps<T> {
     cellClassName?: InfiniteTablePropCellClassName<T>;
     rowClassName?: InfiniteTablePropRowClassName<T>;
     rowHoverClassName?: string;
+    /**
+     * Forces cells to re-render when their row didn't change but something they
+     * render depends on did (eg: cross-row computations). Applies to all columns,
+     * unless a column specifies its own `repaintCellsKey`, which takes precedence.
+     */
+    repaintCellsKey?: InfiniteTablePropRepaintCellsKey<T>;
     columnHeaderHeight?: number | string;
     onKeyDown?: (context: InfiniteTablePublicContext<T> & {
         actions: InfiniteTableEventHandlerContext<T>['actions'];
@@ -3129,6 +3190,7 @@ interface InfiniteTableMappedState<T> {
     columnDefaultSortable: InfiniteTableProps<T>['columnDefaultSortable'];
     rowStyle: InfiniteTableProps<T>['rowStyle'];
     cellStyle: InfiniteTableProps<T>['cellStyle'];
+    repaintCellsKey: InfiniteTableProps<T>['repaintCellsKey'];
     rowProps: InfiniteTableProps<T>['rowProps'];
     rowClassName: InfiniteTableProps<T>['rowClassName'];
     rowHoverClassName: InfiniteTableProps<T>['rowHoverClassName'];
@@ -4611,6 +4673,7 @@ declare const InfiniteTable: vue.DefineComponent<{
     rowHeight?: any;
     rowDetailHeight?: any;
     shouldAcceptEdit?: any;
+    repaintCellsKey?: any;
     repeatWrappedGroupRows?: any;
     showSeparatePivotColumnForSingleAggregation?: any;
     pivotTotalColumnPosition?: any;
@@ -4741,6 +4804,7 @@ declare const InfiniteTable: vue.DefineComponent<{
     rowHeight?: any;
     rowDetailHeight?: any;
     shouldAcceptEdit?: any;
+    repaintCellsKey?: any;
     repeatWrappedGroupRows?: any;
     showSeparatePivotColumnForSingleAggregation?: any;
     pivotTotalColumnPosition?: any;
@@ -5072,6 +5136,7 @@ declare const TreeGrid: vue.DefineComponent<{
     rowHeight?: any;
     rowDetailHeight?: any;
     shouldAcceptEdit?: any;
+    repaintCellsKey?: any;
     repeatWrappedGroupRows?: any;
     showSeparatePivotColumnForSingleAggregation?: any;
     pivotTotalColumnPosition?: any;
@@ -5202,6 +5267,7 @@ declare const TreeGrid: vue.DefineComponent<{
     rowHeight?: any;
     rowDetailHeight?: any;
     shouldAcceptEdit?: any;
+    repaintCellsKey?: any;
     repeatWrappedGroupRows?: any;
     showSeparatePivotColumnForSingleAggregation?: any;
     pivotTotalColumnPosition?: any;
@@ -5713,4 +5779,4 @@ declare const components: {
     }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 };
 
-export { CellSelectionState, type CellSelectionStateObject, type ColumnTypeWithInherit, DataSource, type DataSourceAction, DataSourceActionType, type DataSourceAggregationReducer, type DataSourceApi, type DataSourceCRUDParam, type DataSourceCallback_BaseParam, type DataSourceComponentActions, type DataSourceContextValue, type DataSourceData, type DataSourceDataFn, type DataSourceDataParams, type DataSourceDataParamsChanges, type DataSourceDebugWarningKey, type DataSourceDerivedState, type DataSourceFilterFunctionParam, type DataSourceFilterOperator, type DataSourceFilterOperatorFunction, type DataSourceFilterOperatorFunctionParam, type DataSourceFilterType, type DataSourceFilterValueItem, type DataSourceFilterValueItemValueGetter, type DataSourceGroupBy, type DataSourceGroupRowsList, DataSourceInjectionKeyForVue, type DataSourceInsertParam, type DataSourceLivePaginationCursorFn, type DataSourceLivePaginationCursorParams, type DataSourceLivePaginationCursorValue, type DataSourceMappedState, type DataSourceMappings, type DataSourceMasterDetailContextValue, type DataSourcePivotBy, type DataSourcePropAggregationReducers, type DataSourcePropCellSelection, type DataSourcePropCellSelection_MultiCell, type DataSourcePropCellSelection_SingleCell, type DataSourcePropFilterFunction, type DataSourcePropFilterTypes, type DataSourcePropFilterValue, type DataSourcePropGroupBy, type DataSourcePropGroupRowsState, type DataSourcePropGroupRowsStateObject, type DataSourcePropIsNodeExpanded, type DataSourcePropIsNodeReadOnly, type DataSourcePropIsNodeSelectable, type DataSourcePropIsNodeSelected, type DataSourcePropIsRowSelected, type DataSourcePropLivePaginationCursor, type DataSourcePropMultiRowSelectionChangeParamType, type DataSourcePropOnCellSelectionChange, type DataSourcePropOnCellSelectionChange_MultiCell, type DataSourcePropOnCellSelectionChange_SingleCell, type DataSourcePropOnRowSelectionChange, type DataSourcePropOnRowSelectionChange_MultiRow, type DataSourcePropOnRowSelectionChange_SingleRow, type DataSourcePropOnTreeSelectionChange, type DataSourcePropOnTreeSelectionChange_MultiNode, type DataSourcePropOnTreeSelectionChange_SingleNode, type DataSourcePropPivotBy, type DataSourcePropRowInfoReducers, type DataSourcePropRowSelection, type DataSourcePropRowSelection_MultiRow, type DataSourcePropRowSelection_SingleRow, type DataSourcePropSelectionMode, type DataSourcePropShouldReloadData, type DataSourcePropShouldReloadDataObject, type DataSourcePropSortFn, type DataSourcePropSortInfo, type DataSourcePropSortTypes, type DataSourcePropTreeFilterFunction, type DataSourcePropTreeSelection, type DataSourcePropTreeSelection_MultiNode, type DataSourcePropTreeSelection_SingleNode, type DataSourceProps, type DataSourcePropsWithChildren, type DataSourceRawReducer, type DataSourceRemoteData, type DataSourceRowInfoReducer, type DataSourceSetupState, type DataSourceSingleSortInfo, type DataSourceSortInfo, type DataSourceStableContextValue, type DataSourceState, type DataSourceUpdateParam, type DebugTimingKey, type DebugWarningPayload, DeepMap, type DevToolsDataSourceOverrides, type DevToolsGenericMessage, type DevToolsHookFn, type DevToolsHookFnOptions, type DevToolsHostPageLogMessage, type DevToolsHostPageLogMessagePayload, type DevToolsHostPageMessage, type DevToolsHostPageMessagePayload, type DevToolsHostPageMessageType, type DevToolsInfiniteOverrides, type DevToolsMessageAddress, type DevToolsOverrides, type ErrorCodeKey, FlashingColumnCell, GroupRowsState, type InfiniteColumnEditorContextType, InfiniteTable, type InfiniteTableAction, InfiniteTableActionType, type InfiniteTableApi, type InfiniteTableCellSelectionApi, InfiniteTableClassName, type InfiniteTableColumn, type InfiniteTableColumnAggregator, type InfiniteTableColumnApi, type InfiniteTableColumnCellContextType, type InfiniteTableColumnComparer, type InfiniteTableColumnGroup, type InfiniteTableColumnRenderFunctionForGroupRows, type InfiniteTableColumnRenderFunctionForNormalRows, type InfiniteTableColumnRenderValueParam, type InfiniteTableColumnRowspanParam, type InfiniteTableColumnSizingOptions, type InfiniteTableColumnValueFormatterParams, type InfiniteTableColumnValueGetterParams, type InfiniteTableComputedColumn, type InfiniteTableComputedValues, type InfiniteTableContextValue, type InfiniteTableDebugWarningKey, InfiniteTableDetailRow, type InfiniteTableGroupColumnBase, type InfiniteTableGroupColumnFunction, type InfiniteTableGroupColumnGetterOptions, InfiniteTableInjectionKeyForVue, type InfiniteTableKeyboardNavigationApi, type InfiniteTablePivotColumn, type InfiniteTablePropAutoSizeColumnsKey, type InfiniteTablePropColumnGroupVisibility, type InfiniteTablePropColumnGroups, type InfiniteTablePropColumnOrder, type InfiniteTablePropColumnPinning, type InfiniteTablePropColumnSizing, type InfiniteTablePropColumnTypes, type InfiniteTablePropColumnVisibility, type InfiniteTablePropColumns, type InfiniteTablePropComponents, type InfiniteTablePropGetCellContextMenuItems, type InfiniteTablePropGetColumnMenuItems, type InfiniteTablePropGetContextMenuItems, type InfiniteTablePropGroupColumn, type InfiniteTablePropGroupRenderStrategy, type InfiniteTablePropHeaderOptions, type InfiniteTablePropKeyboardNavigation, type InfiniteTablePropKeyboardShorcut, type InfiniteTablePropMultiSortBehavior, type InfiniteTablePropRowClassName, type InfiniteTablePropRowStyle, type InfiniteTableProps, type InfiniteTableRowClassNameFn, type InfiniteTableRowDetailApi, type InfiniteTableRowInfo, type InfiniteTableRowSelectionApi, type InfiniteTableRowStyleFn, type InfiniteTableState, type InfiniteTable_HasGrouping_RowInfoGroup, type InfiniteTable_HasGrouping_RowInfoNormal, type InfiniteTable_Tree_RowInfoLeafNode, type InfiniteTable_Tree_RowInfoNode, type InfiniteTable_Tree_RowInfoParentNode, type LazyGroupDataDeepMap, type LazyGroupDataItem, type LazyRowInfoGroup, Menu, NumberFilterEditor, RowDetailCache, RowDetailState, type RowDetailStateObject, type RowDisabledStateObject, RowSelectionState, type ScrollStopInfo, type Scrollbars, StringFilterEditor, type TableRenderRange, TreeDataSource, TreeExpandState, type TreeExpandStateValue, TreeGrid, TreeSelectionState, type TreeSelectionStateObject, type TreeSelectionValue, type UpdateChildrenFn, type WaitForNodeOptions, components, createFlashingColumnCellComponent, debounce, defaultFilterTypes, flatten, group, keyboardShortcuts, toTreeDataArray, useDataSourceContext, useGetMasterDetailContextForVue, useInfiniteColumnCell, useInfiniteColumnEditor, useInfiniteColumnFilterEditor, useInfiniteHeaderCell, useInfiniteTableContext, useOverlay, withSelectedLeafNodesOnly };
+export { CellSelectionState, type CellSelectionStateObject, type ColumnTypeWithInherit, DataSource, type DataSourceAction, DataSourceActionType, type DataSourceAggregationReducer, type DataSourceApi, type DataSourceCRUDParam, type DataSourceCallback_BaseParam, type DataSourceComponentActions, type DataSourceContextValue, type DataSourceData, type DataSourceDataFn, type DataSourceDataParams, type DataSourceDataParamsChanges, type DataSourceDebugWarningKey, type DataSourceDerivedState, type DataSourceFilterFunctionParam, type DataSourceFilterOperator, type DataSourceFilterOperatorFunction, type DataSourceFilterOperatorFunctionParam, type DataSourceFilterType, type DataSourceFilterValueItem, type DataSourceFilterValueItemValueGetter, type DataSourceGroupBy, type DataSourceGroupRowsList, DataSourceInjectionKeyForVue, type DataSourceInsertParam, type DataSourceLivePaginationCursorFn, type DataSourceLivePaginationCursorParams, type DataSourceLivePaginationCursorValue, type DataSourceMappedState, type DataSourceMappings, type DataSourceMasterDetailContextValue, type DataSourcePivotBy, type DataSourcePropAggregationReducers, type DataSourcePropCellSelection, type DataSourcePropCellSelection_MultiCell, type DataSourcePropCellSelection_SingleCell, type DataSourcePropFilterFunction, type DataSourcePropFilterTypes, type DataSourcePropFilterValue, type DataSourcePropGroupBy, type DataSourcePropGroupRowsState, type DataSourcePropGroupRowsStateObject, type DataSourcePropIsNodeExpanded, type DataSourcePropIsNodeReadOnly, type DataSourcePropIsNodeSelectable, type DataSourcePropIsNodeSelected, type DataSourcePropIsRowSelected, type DataSourcePropLivePaginationCursor, type DataSourcePropMultiRowSelectionChangeParamType, type DataSourcePropOnCellSelectionChange, type DataSourcePropOnCellSelectionChange_MultiCell, type DataSourcePropOnCellSelectionChange_SingleCell, type DataSourcePropOnRowSelectionChange, type DataSourcePropOnRowSelectionChange_MultiRow, type DataSourcePropOnRowSelectionChange_SingleRow, type DataSourcePropOnTreeSelectionChange, type DataSourcePropOnTreeSelectionChange_MultiNode, type DataSourcePropOnTreeSelectionChange_SingleNode, type DataSourcePropPivotBy, type DataSourcePropRowInfoReducers, type DataSourcePropRowSelection, type DataSourcePropRowSelection_MultiRow, type DataSourcePropRowSelection_SingleRow, type DataSourcePropSelectionMode, type DataSourcePropShouldReloadData, type DataSourcePropShouldReloadDataObject, type DataSourcePropSortFn, type DataSourcePropSortInfo, type DataSourcePropSortTypes, type DataSourcePropTreeFilterFunction, type DataSourcePropTreeSelection, type DataSourcePropTreeSelection_MultiNode, type DataSourcePropTreeSelection_SingleNode, type DataSourceProps, type DataSourcePropsWithChildren, type DataSourceRawReducer, type DataSourceRemoteData, type DataSourceRowInfoReducer, type DataSourceSetupState, type DataSourceSingleSortInfo, type DataSourceSortInfo, type DataSourceStableContextValue, type DataSourceState, type DataSourceUpdateParam, type DebugTimingKey, type DebugWarningPayload, DeepMap, type DevToolsDataSourceOverrides, type DevToolsGenericMessage, type DevToolsHookFn, type DevToolsHookFnOptions, type DevToolsHostPageLogMessage, type DevToolsHostPageLogMessagePayload, type DevToolsHostPageMessage, type DevToolsHostPageMessagePayload, type DevToolsHostPageMessageType, type DevToolsInfiniteOverrides, type DevToolsMessageAddress, type DevToolsOverrides, type ErrorCodeKey, FlashingColumnCell, GroupRowsState, type InfiniteColumnEditorContextType, InfiniteTable, type InfiniteTableAction, InfiniteTableActionType, type InfiniteTableApi, type InfiniteTableCellSelectionApi, InfiniteTableClassName, type InfiniteTableColumn, type InfiniteTableColumnAggregator, type InfiniteTableColumnApi, type InfiniteTableColumnCellContextType, type InfiniteTableColumnComparer, type InfiniteTableColumnGroup, type InfiniteTableColumnRenderFunctionForGroupRows, type InfiniteTableColumnRenderFunctionForNormalRows, type InfiniteTableColumnRenderValueParam, type InfiniteTableColumnRowspanParam, type InfiniteTableColumnSizingOptions, type InfiniteTableColumnValueFormatterParams, type InfiniteTableColumnValueGetterParams, type InfiniteTableComputedColumn, type InfiniteTableComputedValues, type InfiniteTableContextValue, type InfiniteTableDebugWarningKey, InfiniteTableDetailRow, type InfiniteTableGroupColumnBase, type InfiniteTableGroupColumnFunction, type InfiniteTableGroupColumnGetterOptions, InfiniteTableInjectionKeyForVue, type InfiniteTableKeyboardNavigationApi, type InfiniteTablePivotColumn, type InfiniteTablePropAutoSizeColumnsKey, type InfiniteTablePropColumnGroupVisibility, type InfiniteTablePropColumnGroups, type InfiniteTablePropColumnOrder, type InfiniteTablePropColumnPinning, type InfiniteTablePropColumnSizing, type InfiniteTablePropColumnTypes, type InfiniteTablePropColumnVisibility, type InfiniteTablePropColumns, type InfiniteTablePropComponents, type InfiniteTablePropGetCellContextMenuItems, type InfiniteTablePropGetColumnMenuItems, type InfiniteTablePropGetContextMenuItems, type InfiniteTablePropGroupColumn, type InfiniteTablePropGroupRenderStrategy, type InfiniteTablePropHeaderOptions, type InfiniteTablePropKeyboardNavigation, type InfiniteTablePropKeyboardShorcut, type InfiniteTablePropMultiSortBehavior, type InfiniteTablePropRepaintCellsKey, type InfiniteTablePropRepaintCellsKeyFn, type InfiniteTablePropRepaintCellsKeyFnParams, type InfiniteTablePropRowClassName, type InfiniteTablePropRowStyle, type InfiniteTableProps, type InfiniteTableRowClassNameFn, type InfiniteTableRowDetailApi, type InfiniteTableRowInfo, type InfiniteTableRowSelectionApi, type InfiniteTableRowStyleFn, type InfiniteTableState, type InfiniteTable_HasGrouping_RowInfoGroup, type InfiniteTable_HasGrouping_RowInfoNormal, type InfiniteTable_Tree_RowInfoLeafNode, type InfiniteTable_Tree_RowInfoNode, type InfiniteTable_Tree_RowInfoParentNode, type LazyGroupDataDeepMap, type LazyGroupDataItem, type LazyRowInfoGroup, Menu, NumberFilterEditor, RowDetailCache, RowDetailState, type RowDetailStateObject, type RowDisabledStateObject, RowSelectionState, type ScrollStopInfo, type Scrollbars, StringFilterEditor, type TableRenderRange, TreeDataSource, TreeExpandState, type TreeExpandStateValue, TreeGrid, TreeSelectionState, type TreeSelectionStateObject, type TreeSelectionValue, type UpdateChildrenFn, type WaitForNodeOptions, components, createFlashingColumnCellComponent, debounce, defaultFilterTypes, flatten, group, keyboardShortcuts, toTreeDataArray, useDataSourceContext, useGetMasterDetailContextForVue, useInfiniteColumnCell, useInfiniteColumnEditor, useInfiniteColumnFilterEditor, useInfiniteHeaderCell, useInfiniteTableContext, useOverlay, withSelectedLeafNodesOnly };