@infinite-table/infinite-react 1.1.0-canary.0 → 1.2.0

package/README.md

@@ -55,6 +55,8 @@
  fixed and flexible columns](https://infinite-table.com/docs/latest/learn/columns/fixed-and-flexible-size)
 * [<img src="https://infinite-table.com/icons/column-grouping.svg" align="center" />
  column grouping](https://infinite-table.com/docs/latest/learn/column-groups)
+* [<img src="https://infinite-table.com/icons/filtering.svg" align="center" />
+ filtering](https://infinite-table.com/docs/latest/learn/filtering)
 * [<img src="https://infinite-table.com/icons/theming.svg" align="center" />
  theming](https://infinite-table.com/docs/latest/learn/theming)
 

package/index.d.ts

@@ -913,6 +913,11 @@ interface InfiniteTableComputedValues<T> {
     columnSize: (colIndex: number) => number;
 }
 
+type PointCoords = {
+    top: number;
+    left: number;
+};
+
 type TableRenderCellFnParam = {
     domRef: RefCallback<HTMLElement>;
     rowIndex: number;
@@ -1050,6 +1055,20 @@ declare class ScrollListener {
     destroy: () => void;
 }
 
+type CellContextMenuLocation = {
+    rowId: any;
+    rowIndex: number;
+    columnId: string;
+    colIndex: number;
+};
+type CellContextMenuLocationWithEvent = CellContextMenuLocation & {
+    event: React.MouseEvent;
+    target: HTMLElement;
+};
+type ContextMenuLocationWithEvent = Partial<CellContextMenuLocation> & {
+    event: React.MouseEvent;
+    target: HTMLElement;
+};
 interface InfiniteTableSetupState<T> {
     renderer: ReactHeadlessTableRenderer;
     getDOMNodeForCell: (cellPos: CellPosition) => HTMLElement | null;
@@ -1071,7 +1090,13 @@ interface InfiniteTableSetupState<T> {
         target: HTMLElement | EventTarget;
         column: InfiniteTableComputedColumn<T>;
     }>;
-    columnContextMenuVisibleForColumnId: string | null;
+    cellContextMenu: SubscriptionCallback<CellContextMenuLocationWithEvent>;
+    contextMenu: SubscriptionCallback<ContextMenuLocationWithEvent>;
+    cellContextMenuVisibleFor: CellContextMenuLocation | null;
+    contextMenuVisibleFor: (Partial<CellContextMenuLocation> & {
+        point: PointCoords;
+    }) | null;
+    columnMenuVisibleForColumnId: string | null;
     filterOperatorMenuVisibleForColumnId: string | null;
     onColumnHeaderHeightCSSVarChange: SubscriptionCallback<number>;
     cellClick: SubscriptionCallback<CellPosition & {
@@ -1128,7 +1153,9 @@ interface InfiniteTableMappedState<T> {
     onCellClick: InfiniteTableProps<T>['onCellClick'];
     headerOptions: NonUndefined<InfiniteTableProps<T>['headerOptions']>;
     onScrollbarsChange: InfiniteTableProps<T>['onScrollbarsChange'];
-    getColumContextMenuItems: InfiniteTableProps<T>['getColumContextMenuItems'];
+    getContextMenuItems: InfiniteTableProps<T>['getContextMenuItems'];
+    getCellContextMenuItems: InfiniteTableProps<T>['getCellContextMenuItems'];
+    getColumnMenuItems: InfiniteTableProps<T>['getColumnMenuItems'];
     getFilterOperatorMenuItems: InfiniteTableProps<T>['getFilterOperatorMenuItems'];
     columnPinning: InfiniteTablePropColumnPinning;
     loadingText: InfiniteTableProps<T>['loadingText'];
@@ -1136,6 +1163,8 @@ interface InfiniteTableMappedState<T> {
     columns: InfiniteTableColumnsMap<T>;
     pivotColumns: InfiniteTableProps<T>['pivotColumns'];
     onReady: InfiniteTableProps<T>['onReady'];
+    onContextMenu: InfiniteTableProps<T>['onContextMenu'];
+    onCellContextMenu: InfiniteTableProps<T>['onCellContextMenu'];
     onSelfFocus: InfiniteTableProps<T>['onSelfFocus'];
     onSelfBlur: InfiniteTableProps<T>['onSelfBlur'];
     onFocusWithin: InfiniteTableProps<T>['onFocusWithin'];
@@ -1215,6 +1244,43 @@ type InfiniteTableActions<T> = ComponentStateActions<InfiniteTableState<T>>;
 interface InfiniteTableState<T> extends InfiniteTableMappedState<T>, InfiniteTableDerivedState<T>, InfiniteTableSetupState<T> {
 }
 
+type ArrayOfIds = Pick<InfiniteTable_RowInfoBase<any>, 'id'>[];
+type InfiniteTableSelectionApi = {
+    get allRowsSelected(): boolean;
+    isRowSelected(pk: any, groupKeys?: any[]): boolean;
+    isRowDeselected(pk: any, groupKeys?: any[]): boolean;
+    selectRow(pk: any, groupKeys?: any[]): void;
+    deselectRow(pk: any, groupKeys?: any[]): void;
+    toggleRowSelection(pk: any, groupKeys?: any[]): void;
+    selectGroupRow(groupKeys: any[], children?: ArrayOfIds): void;
+    deselectGroupRow(groupKeys: any[], children?: ArrayOfIds): void;
+    toggleGroupRowSelection(groupKeys: any[], children?: ArrayOfIds): void;
+    getGroupRowSelectionState(groupKeys: any[]): boolean | null;
+    getSelectedPrimaryKeys(rowSelection?: RowSelectionStateObject): (string | number)[];
+    selectAll(): void;
+    deselectAll(): void;
+};
+
+type InfiniteTableEventHandlerContext<T> = {
+    getComputed: () => InfiniteTableComputedValues<T>;
+    getState: () => InfiniteTableState<T>;
+    actions: InfiniteTableActions<T>;
+    cloneRowSelection: (rowSelection: RowSelectionState<T>) => RowSelectionState<T>;
+    getDataSourceState: () => DataSourceState<T>;
+    dataSourceActions: DataSourceComponentActions<T>;
+    api: InfiniteTableApi<T>;
+    dataSourceApi: DataSourceApi<T>;
+};
+type InfiniteTableKeyboardEventHandlerContext<T> = InfiniteTableEventHandlerContext<T>;
+type InfiniteTableCellClickEventHandlerContext<T> = InfiniteTableEventHandlerContext<T> & {
+    rowIndex: number;
+    colIndex: number;
+    column: InfiniteTableComputedColumn<T>;
+    columnApi: InfiniteTableColumnApi<T>;
+};
+
+type OnCellClickContext<T> = InfiniteTableCellClickEventHandlerContext<T> & InfiniteTableKeyboardEventHandlerContext<T>;
+
 interface InfiniteTableContextValue<T> {
     api: InfiniteTableApi<T>;
     dataSourceApi: DataSourceApi<T>;
@@ -1226,6 +1292,18 @@ interface InfiniteTableContextValue<T> {
     getState: () => InfiniteTableState<T>;
     getDataSourceState: () => DataSourceState<T>;
 }
+interface InfiniteTablePublicContext<T> {
+    api: InfiniteTableApi<T>;
+    dataSourceApi: DataSourceApi<T>;
+    getState: () => InfiniteTableState<T>;
+    getDataSourceState: () => DataSourceState<T>;
+}
+interface InfiniteTableCellContext<T> {
+    rowIndex: OnCellClickContext<T>['rowIndex'];
+    colIndex: OnCellClickContext<T>['colIndex'];
+    column: InfiniteTableComputedColumn<T>;
+    columnApi: InfiniteTableColumnApi<T>;
+}
 
 type GroupKeyType$1<T extends any = any> = T;
 type GroupBy<DataType, KeyType> = {
@@ -1966,28 +2044,6 @@ type InfiniteCheckBoxProps = {
 };
 declare function InfiniteCheckBox(props: InfiniteCheckBoxProps): JSX.Element;
 
-type ArrayOfIds = Pick<InfiniteTable_RowInfoBase<any>, 'id'>[];
-type InfiniteTableSelectionApi = {
-    get allRowsSelected(): boolean;
-    isRowSelected(pk: any, groupKeys?: any[]): boolean;
-    isRowDeselected(pk: any, groupKeys?: any[]): boolean;
-    selectRow(pk: any, groupKeys?: any[]): void;
-    deselectRow(pk: any, groupKeys?: any[]): void;
-    toggleRowSelection(pk: any, groupKeys?: any[]): void;
-    selectGroupRow(groupKeys: any[], children?: ArrayOfIds): void;
-    deselectGroupRow(groupKeys: any[], children?: ArrayOfIds): void;
-    toggleGroupRowSelection(groupKeys: any[], children?: ArrayOfIds): void;
-    getGroupRowSelectionState(groupKeys: any[]): boolean | null;
-    getSelectedPrimaryKeys(rowSelection?: RowSelectionStateObject): (string | number)[];
-    selectAll(): void;
-    deselectAll(): void;
-};
-
-type PointCoords = {
-    top: number;
-    left: number;
-};
-
 type CoordsWithSize = {
     width: number;
     height: number;
@@ -2167,24 +2223,6 @@ type MenuColumnRenderParam = {
     domProps: HTMLProps<HTMLDivElement>;
 };
 
-type InfiniteTableEventHandlerContext<T> = {
-    getComputed: () => InfiniteTableComputedValues<T>;
-    getState: () => InfiniteTableState<T>;
-    actions: InfiniteTableActions<T>;
-    cloneRowSelection: (rowSelection: RowSelectionState<T>) => RowSelectionState<T>;
-    getDataSourceState: () => DataSourceState<T>;
-    dataSourceActions: DataSourceComponentActions<T>;
-    api: InfiniteTableApi<T>;
-    dataSourceApi: DataSourceApi<T>;
-};
-type InfiniteTableKeyboardEventHandlerContext<T> = InfiniteTableEventHandlerContext<T>;
-type InfiniteTableCellClickEventHandlerContext<T> = InfiniteTableEventHandlerContext<T> & {
-    rowIndex: number;
-    colIndex: number;
-};
-
-type OnCellClickContext<T> = InfiniteTableCellClickEventHandlerContext<T> & InfiniteTableKeyboardEventHandlerContext<T>;
-
 type LoadMaskProps = {
     visible: boolean;
     children: Renderable;
@@ -2409,11 +2447,14 @@ type ScrollStopInfo = {
     firstVisibleRowIndex: number;
     lastVisibleRowIndex: number;
 };
-type InfiniteTableRowInfoDataDiscriminatorWithColumnAndApis<T> = {
+type InfiniteTableRowInfoDataDiscriminatorWithColumn<T> = {
     column: InfiniteTableComputedColumn<T>;
+    columnApi: InfiniteTableColumnApi<T>;
+} & InfiniteTableRowInfoDataDiscriminator<T>;
+type InfiniteTableRowInfoDataDiscriminatorWithColumnAndApis<T> = {
     api: InfiniteTableApi<T>;
     dataSourceApi: DataSourceApi<T>;
-} & InfiniteTableRowInfoDataDiscriminator<T>;
+} & InfiniteTableRowInfoDataDiscriminatorWithColumn<T>;
 type InfiniteTablePropsEditable<T> = InfiniteTableColumnEditableFn<T> | undefined;
 type InfiniteTablePropOnEditAcceptedParams<T> = InfiniteTableRowInfoDataDiscriminatorWithColumnAndApis<T> & {
     initialValue: any;
@@ -2472,19 +2513,15 @@ interface InfiniteTableProps<T> {
     rowStyle?: InfiniteTablePropRowStyle<T>;
     rowClassName?: InfiniteTablePropRowClassName<T>;
     columnHeaderHeight: number | string;
-    onKeyDown?: (context: {
-        api: InfiniteTableEventHandlerContext<T>['api'];
-        getState: InfiniteTableEventHandlerContext<T>['getState'];
-        getDataSourceState: InfiniteTableEventHandlerContext<T>['getDataSourceState'];
+    onKeyDown?: (context: InfiniteTablePublicContext<T> & {
         actions: InfiniteTableEventHandlerContext<T>['actions'];
     }, event: React$1.KeyboardEvent) => void;
-    onCellClick?: (context: {
-        rowIndex: OnCellClickContext<T>['rowIndex'];
-        colIndex: OnCellClickContext<T>['colIndex'];
-        api: OnCellClickContext<T>['api'];
-        getState: OnCellClickContext<T>['getState'];
-        getDataSourceState: OnCellClickContext<T>['getDataSourceState'];
-        actions: OnCellClickContext<T>['actions'];
+    onCellClick?: (context: InfiniteTablePublicContext<T> & InfiniteTableCellContext<T>, event: React$1.MouseEvent) => void;
+    onContextMenu?: (context: InfiniteTablePublicContext<T> & {
+        event: React$1.MouseEvent;
+    } & Partial<InfiniteTableRowInfoDataDiscriminatorWithColumn<T>>, event: React$1.MouseEvent) => void;
+    onCellContextMenu?: (context: InfiniteTablePublicContext<T> & InfiniteTableRowInfoDataDiscriminatorWithColumn<T> & {
+        event: React$1.MouseEvent;
     }, event: React$1.MouseEvent) => void;
     /**
      * Properties to be sent directly to the DOM element underlying InfiniteTable.
@@ -2546,16 +2583,26 @@ interface InfiniteTableProps<T> {
     licenseKey?: string;
     scrollTopKey?: string | number;
     autoSizeColumnsKey?: InfiniteTablePropAutoSizeColumnsKey;
-    getColumContextMenuItems?: InfiniteTablePropGetColumnContextMenuItems<T>;
+    getCellContextMenuItems?: InfiniteTablePropGetCellContextMenuItems<T>;
+    getContextMenuItems?: InfiniteTablePropGetContextMenuItems<T>;
+    getColumnMenuItems?: InfiniteTablePropGetColumnMenuItems<T>;
     getFilterOperatorMenuItems?: InfiniteTablePropGetFilterOperatorMenuItems<T>;
 }
-type InfiniteTablePropGetColumnContextMenuItems<T> = (defaultItems: Exclude<MenuProps['items'], undefined>, params: {
+type InfiniteTablePropGetColumnMenuItems<T> = (defaultItems: Exclude<MenuProps['items'], undefined>, params: {
     column: InfiniteTableComputedColumn<T>;
-    api: InfiniteTableApi<T>;
-    getState: () => InfiniteTableState<T>;
+    columnApi: InfiniteTableColumnApi<T>;
     getComputed: () => InfiniteTableComputedValues<T>;
-    actions: InfiniteTableActions<T>;
-}) => MenuProps['items'];
+} & InfiniteTablePublicContext<T>) => MenuProps['items'];
+type GetContextMenuItemsReturnType = MenuProps['items'] | null | {
+    items: MenuProps['items'];
+    columns: MenuColumn[];
+};
+type InfiniteTablePropGetCellContextMenuItems<T> = (info: InfiniteTableRowInfoDataDiscriminatorWithColumn<T> & {
+    event: React$1.MouseEvent;
+}, params: InfiniteTablePublicContext<T>) => GetContextMenuItemsReturnType;
+type InfiniteTablePropGetContextMenuItems<T> = (param: {
+    event: React$1.MouseEvent;
+} & Partial<InfiniteTableRowInfoDataDiscriminatorWithColumn<T>>, params: InfiniteTablePublicContext<T>) => GetContextMenuItemsReturnType;
 type InfiniteTablePropGetFilterOperatorMenuItems<T> = (defaultItems: Exclude<MenuProps['items'], undefined>, params: {
     column: InfiniteTableComputedColumn<T>;
     filterTypes: DataSourceProps<T>['filterTypes'];
@@ -2657,4 +2704,4 @@ declare const components: {
     NumberFilterEditor: typeof NumberFilterEditor;
 };
 
-export { AdvancedAlignable, ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceApi, DataSourceCRUDParam, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceInsertParam, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropCellSelection, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropIsRowSelected, DataSourcePropLivePaginationCursor, DataSourcePropMultiRowSelectionChangeParamType, DataSourcePropOnCellSelectionChange, DataSourcePropOnRowSelectionChange, DataSourcePropOnRowSelectionChange_MultiRow, DataSourcePropOnRowSelectionChange_SingleRow, DataSourcePropPivotBy, DataSourcePropRowSelection, DataSourcePropRowSelection_MultiRow, DataSourcePropRowSelection_SingleRow, DataSourcePropSelectionMode, DataSourcePropSortInfo, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, ElementContainerGetter, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableApi, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnApi, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderFunctionForGroupRows, InfiniteTableColumnRenderFunctionForNormalRows, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableColumnsMap, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropComponents, InfiniteTablePropGetColumnContextMenuItems, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropKeyboardNavigation, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, Menu, MenuChildrenFnParam, MenuColumn, MenuColumnRenderParam, MenuDecoration, MenuItemDefinition, MenuItemObject, MenuProps, MenuRenderable, MenuRuntimeItem, MenuRuntimeItemSelectable, MenuSeparator, OverlayShowParams, RowSelectionState, Scrollbars, components, debounce, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteColumnEditor, useInfiniteColumnFilterEditor, useInfiniteHeaderCell, useOverlay, useOverlayPortal };
+export { AdvancedAlignable, ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceApi, DataSourceCRUDParam, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceInsertParam, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropCellSelection, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropIsRowSelected, DataSourcePropLivePaginationCursor, DataSourcePropMultiRowSelectionChangeParamType, DataSourcePropOnCellSelectionChange, DataSourcePropOnRowSelectionChange, DataSourcePropOnRowSelectionChange_MultiRow, DataSourcePropOnRowSelectionChange_SingleRow, DataSourcePropPivotBy, DataSourcePropRowSelection, DataSourcePropRowSelection_MultiRow, DataSourcePropRowSelection_SingleRow, DataSourcePropSelectionMode, DataSourcePropSortInfo, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, ElementContainerGetter, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableApi, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnApi, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderFunctionForGroupRows, InfiniteTableColumnRenderFunctionForNormalRows, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableColumnsMap, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropComponents, InfiniteTablePropGetCellContextMenuItems, InfiniteTablePropGetColumnMenuItems, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropKeyboardNavigation, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, Menu, MenuChildrenFnParam, MenuColumn, MenuColumnRenderParam, MenuDecoration, MenuItemDefinition, MenuItemObject, MenuProps, MenuRenderable, MenuRuntimeItem, MenuRuntimeItemSelectable, MenuSeparator, OverlayShowParams, RowSelectionState, Scrollbars, components, debounce, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteColumnEditor, useInfiniteColumnFilterEditor, useInfiniteHeaderCell, useOverlay, useOverlayPortal };