@infinite-table/infinite-vue 9.1.5 → 9.2.0

package/index.d.ts

@@ -1425,6 +1425,13 @@ type RowSelectionStateConfig<T> = {
     indexer: DataSourceState<T>['indexer'];
     lazyLoad: boolean;
     onlyUsePrimaryKeys: boolean;
+    multiRowSelectionTarget?: DataSourcePropMultiRowSelectionTarget;
+    /**
+     * Whether the client-side filter hides some of the rows
+     */
+    someRowsFilteredOut?: boolean;
+    originalDataArray?: T[];
+    postFilterDataArray?: T[];
 };
 type GetRowSelectionStateConfig<T> = () => RowSelectionStateConfig<T>;
 type RowSelectionStateOverride = {
@@ -1449,6 +1456,21 @@ declare class RowSelectionState<T = any> {
     getConfig: GetRowSelectionStateConfig<T>;
     getGroupKeysForPrimaryKey(pk: any): any[];
     getGroupDeepMap(): DeepMap<any, DeepMapGroupValueType<T, any>> | undefined;
+    /**
+     * The selection acts only on the rows that pass the filter, and some rows are filtered out
+     */
+    private targetsVisibleRowsOnly;
+    /**
+     * The selection also acts on rows that are filtered out, and some rows are filtered out
+     */
+    private targetsFilteredOutRows;
+    private getVisibleDataInsideGroup;
+    private hasFilteredOutRowsInsideGroup;
+    /**
+     * Sets the selection of each visible row inside the group, by its full path,
+     * so the rows of the group that are filtered out keep their selection
+     */
+    private setVisibleRowsSelection;
     getGroupCount(groupKeys: any[]): number;
     getGroupKeysDirectlyInsideGroup(groupKeys: any[]): any[][];
     getAllPrimaryKeysInsideGroup(groupKeys: any[]): any[];
@@ -1797,8 +1819,13 @@ type TreeSelectionStateObject = {
 type TreeSelectionStateConfigObject = {
     treePaths: DeepMap<any, true>;
     strictCheckPaths: boolean;
+    multiRowSelectionTarget?: DataSourcePropMultiRowSelectionTarget;
+    unfilteredTreePaths?: DeepMap<any, true>;
 };
 type TreeSelectionStateConfigParam<_T = any> = {
+    /**
+     * The paths the selection counts and acts on
+     */
     treePaths: TreeSelectionStateConfigObject['treePaths'] | any[][];
     /**
      * Defaults to true. If false, when checking if a given path is selected,
@@ -1808,6 +1835,13 @@ type TreeSelectionStateConfigParam<_T = any> = {
      * If true, will check for the path both in the treePaths and the selectionMap.
      */
     strictCheckPaths?: boolean;
+    /**
+     * When `'visible'`, `treePaths` should only contain the paths that pass the filter,
+     * and `unfilteredTreePaths` all the paths, so the selection
+     * of the nodes that are filtered out is never changed.
+     */
+    multiRowSelectionTarget?: DataSourcePropMultiRowSelectionTarget;
+    unfilteredTreePaths?: TreeSelectionStateConfigObject['treePaths'] | any[][];
 };
 type GetTreeSelectionStateConfig<T> = TreeSelectionStateConfigParam<T> | (() => TreeSelectionStateConfigParam<T>);
 type NodeSelectionState = {
@@ -1837,6 +1871,12 @@ declare class TreeSelectionState<T = any> {
     static from<T>(treeSelectionState: TreeSelectionStateObject, getConfig: GetTreeSelectionStateConfig<T>): TreeSelectionState<T>;
     constructor(state: TreeSelectionStateObject | TreeSelectionState, getConfig?: GetTreeSelectionStateConfig<T>);
     setConfig(getConfig: GetTreeSelectionStateConfig<T>): void;
+    private hasFilteredOutLeavesInside;
+    /**
+     * Sets the selection of each visible leaf node inside the node, by its path,
+     * so the leaf nodes that are filtered out keep their selection
+     */
+    private setVisibleLeafNodesSelection;
     private xcache;
     private update;
     private setSelectionForPath;
@@ -3897,6 +3937,11 @@ interface DataSourceDataParams<T> {
     lazyLoadBatchSize?: number;
     lazyLoadStartIndex?: number;
     groupKeys?: any[];
+    /**
+     * Only passed with `lazyLoad`: the rows a stored multi row selection covers.
+     * For `'visible'`, a selected group or `defaultSelection: true` covers only the rows that pass `filterValue`.
+     */
+    multiRowSelectionTarget?: DataSourcePropMultiRowSelectionTarget;
     append?: boolean;
     aggregationReducers?: DataSourcePropAggregationReducers<T>;
     livePaginationCursor?: DataSourceLivePaginationCursorValue;
@@ -3964,6 +4009,7 @@ interface DataSourceMappedState<T> {
     rowInfoReducers: DataSourceProps<T>['rowInfoReducers'];
     lazyLoad: DataSourceProps<T>['lazyLoad'];
     useGroupKeysForMultiRowSelection: NonUndefined<DataSourceProps<T>['useGroupKeysForMultiRowSelection']>;
+    multiRowSelectionTarget: NonUndefined<DataSourceProps<T>['multiRowSelectionTarget']>;
     onDataParamsChange: DataSourceProps<T>['onDataParamsChange'];
     data: DataSourceProps<T>['data'];
     sortFunction: DataSourceProps<T>['sortFunction'];
@@ -4128,6 +4174,7 @@ type DataSourcePropCellSelection_MultiCell = CellSelectionStateObject | CellSele
 type DataSourcePropCellSelection_SingleCell = null | CellSelectionPosition;
 type DataSourcePropCellSelection = DataSourcePropCellSelection_MultiCell | DataSourcePropCellSelection_SingleCell;
 type DataSourcePropSelectionMode = false | 'single-cell' | 'single-row' | 'multi-cell' | 'multi-row';
+type DataSourcePropMultiRowSelectionTarget = 'all' | 'visible';
 type DataSourcePropOnRowSelectionChange_MultiRow = (rowSelection: DataSourcePropRowSelection_MultiRow, selectionMode: 'multi-row') => void;
 type DataSourcePropOnTreeSelectionChange_MultiNode<T = any> = (treeSelectionStateObject: TreeSelectionStateObject, params: {
     treeSelectionState: TreeSelectionState<T>;
@@ -4262,6 +4309,7 @@ type DataSourceProps<T> = {
     data: DataSourceData<T>;
     selectionMode?: DataSourcePropSelectionMode;
     useGroupKeysForMultiRowSelection?: boolean;
+    multiRowSelectionTarget?: DataSourcePropMultiRowSelectionTarget;
     rowSelection?: DataSourcePropRowSelection;
     defaultRowSelection?: DataSourcePropRowSelection;
     cellSelection?: DataSourcePropCellSelection_MultiCell | DataSourcePropCellSelection_SingleCell;
@@ -4491,6 +4539,7 @@ declare const DataSource: vue.DefineComponent<{
     nodesKey?: any;
     groupBy?: any;
     pivotBy?: any;
+    multiRowSelectionTarget?: any;
     rowSelection?: any;
     debugId?: any;
     sortMode?: any;
@@ -4569,6 +4618,7 @@ declare const DataSource: vue.DefineComponent<{
     nodesKey?: any;
     groupBy?: any;
     pivotBy?: any;
+    multiRowSelectionTarget?: any;
     rowSelection?: any;
     debugId?: any;
     sortMode?: any;
@@ -5391,6 +5441,7 @@ declare const TreeDataSource: vue.DefineComponent<{
     nodesKey?: any;
     groupBy?: any;
     pivotBy?: any;
+    multiRowSelectionTarget?: any;
     rowSelection?: any;
     debugId?: any;
     sortMode?: any;
@@ -5469,6 +5520,7 @@ declare const TreeDataSource: vue.DefineComponent<{
     nodesKey?: any;
     groupBy?: any;
     pivotBy?: any;
+    multiRowSelectionTarget?: any;
     rowSelection?: any;
     debugId?: any;
     sortMode?: any;
@@ -5779,4 +5831,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 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 };
+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 DataSourcePropMultiRowSelectionTarget, 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 };