@infinite-table/infinite-react 0.3.3 → 0.3.4

package/index.d.ts

@@ -1,6 +1,6 @@
 import * as _vanilla_extract_private from '@vanilla-extract/private';
 import * as React$1 from 'react';
-import { MutableRefObject, CSSProperties, HTMLProps } from 'react';
+import { RefCallback, MutableRefObject, CSSProperties, HTMLProps } from 'react';
 
 declare function debounce(fn: Function, { wait }: {
     wait: number;
@@ -303,7 +303,7 @@ declare class MatrixBrain extends Logger {
         x: number;
         y: number;
     };
-    private getItemOffsetFor;
+    getItemOffsetFor: (itemIndex: number, direction: 'horizontal' | 'vertical') => number;
     private computeCacheFor;
     private getItemSizeCacheFor;
     private computeItemSpanUpTo;
@@ -358,6 +358,89 @@ declare class MatrixBrain extends Logger {
     destroy: () => void;
 }
 
+declare type TableRenderCellFnParam = {
+    domRef: RefCallback<HTMLElement>;
+    rowIndex: number;
+    colIndex: number;
+    rowspan: number;
+    colspan: number;
+    hidden: boolean;
+    width: number;
+    height: number;
+    widthWithColspan: number;
+    heightWithRowspan: number;
+    rowFixed: FixedPosition;
+    colFixed: FixedPosition;
+    onMouseEnter: VoidFunction;
+    onMouseLeave: VoidFunction;
+};
+declare type TableRenderCellFn = (param: TableRenderCellFnParam) => Renderable;
+declare class ReactHeadlessTableRenderer extends Logger {
+    private brain;
+    private destroyed;
+    private scrolling;
+    cellHoverClassNames: string[];
+    private itemDOMElements;
+    private itemDOMRefs;
+    private updaters;
+    private mappedCells;
+    private items;
+    private currentHoveredRow;
+    private onDestroy;
+    private hoverRowUpdatesInProgress;
+    constructor(brain: MatrixBrain);
+    getFullyVisibleRowsRange: () => {
+        start: number;
+        end: number;
+    } | null;
+    getScrollPositionForScrollRowIntoView: (rowIndex: number, config?: {
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offset?: number;
+    }) => ScrollPosition;
+    getScrollPositionForScrollColumnIntoView: (colIndex: number, config?: {
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offset?: number;
+    }) => ScrollPosition;
+    getScrollPositionForScrollCellIntoView: (rowIndex: number, colIndex: number, config?: {
+        rowScrollAdjustPosition?: ScrollAdjustPosition;
+        colScrollAdjustPosition?: ScrollAdjustPosition;
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offsetTop: number;
+        offsetLeft: number;
+    }) => ScrollPosition;
+    isRowFullyVisible: (rowIndex: number, offsetMargin?: number) => boolean;
+    isRowVisible: (rowIndex: number, offsetMargin?: number) => boolean;
+    isRowRendered: (rowIndex: number) => boolean;
+    isCellVisible: (rowIndex: number, colIndex: number) => boolean;
+    isCellFullyVisible: (rowIndex: number, colIndex: number) => boolean;
+    isColumnFullyVisible: (colIndex: number, offsetMargin?: number) => boolean;
+    isColumnVisible: (colIndex: number, offsetMargin?: number) => boolean;
+    isCellRendered: (rowIndex: number, colIndex: number) => boolean;
+    isColumnRendered: (colIndex: number) => boolean;
+    getExtraSpanCellsForRange: (range: TableRenderRange) => [number, number][];
+    renderRange: (range: TableRenderRange, { renderCell, force, onRender, }: {
+        force?: boolean | undefined;
+        renderCell: TableRenderCellFn;
+        onRender: (items: Renderable[]) => void;
+    }) => Renderable[];
+    private renderElement;
+    getFixedRanges: (currentRenderRange: TableRenderRange) => TableRenderRange[];
+    private isCellFixed;
+    private isCellCovered;
+    private renderCellAtElement;
+    private onMouseEnter;
+    private addHoverClass;
+    private onMouseLeave;
+    private removeHoverClass;
+    private updateHoverClassNamesForRow;
+    private updateElementPosition;
+    private onScrollStart;
+    private onScrollStop;
+    adjustFixedElementsOnScroll: (scrollPosition?: ScrollPosition) => void;
+    destroy: () => void;
+    reset(): void;
+}
+
 declare type ComponentStateContext<T_STATE, T_ACTIONS> = {
     getComponentState: () => T_STATE;
     componentState: T_STATE;
@@ -395,6 +478,8 @@ declare class ScrollListener {
 }
 
 interface InfiniteTableSetupState<T> {
+    renderer: ReactHeadlessTableRenderer;
+    onRenderUpdater: SubscriptionCallback<Renderable>;
     propsCache: Map<keyof InfiniteTableProps<T>, WeakMap<any, any>>;
     columnsWhenInlineGroupRenderStrategy?: Map<string, InfiniteTableColumn<T>>;
     domRef: MutableRefObject<HTMLDivElement | null>;
@@ -434,6 +519,8 @@ interface InfiniteTableMappedState<T> {
     onFocusWithin: InfiniteTableProps<T>['onFocusWithin'];
     onBlurWithin: InfiniteTableProps<T>['onBlurWithin'];
     autoSizeColumnsKey: InfiniteTableProps<T>['autoSizeColumnsKey'];
+    activeRowIndex: number | null;
+    activeCellIndex: [number, number] | null;
     scrollStopDelay: NonUndefined<InfiniteTableProps<T>['scrollStopDelay']>;
     onScrollToTop: InfiniteTableProps<T>['onScrollToTop'];
     onScrollToBottom: InfiniteTableProps<T>['onScrollToBottom'];
@@ -453,7 +540,6 @@ interface InfiniteTableMappedState<T> {
     pinnedEndMaxWidth: InfiniteTableProps<T>['pinnedEndMaxWidth'];
     pivotColumn: InfiniteTableProps<T>['pivotColumn'];
     pivotColumnGroups: InfiniteTablePropColumnGroupsMap;
-    activeIndex: NonUndefined<InfiniteTableProps<T>['activeIndex']>;
     columnMinWidth: NonUndefined<InfiniteTableProps<T>['columnMinWidth']>;
     columnMaxWidth: NonUndefined<InfiniteTableProps<T>['columnMaxWidth']>;
     columnDefaultWidth: NonUndefined<InfiniteTableProps<T>['columnDefaultWidth']>;
@@ -481,6 +567,7 @@ interface InfiniteTableMappedState<T> {
 interface InfiniteTableDerivedState<T> {
     groupBy: DataSourceProps<T>['groupBy'];
     computedColumns: Map<string, InfiniteTableColumn<T>>;
+    enableKeyboardNavigation: boolean;
     groupRenderStrategy: NonUndefined<InfiniteTableProps<T>['groupRenderStrategy']>;
     columnHeaderCssEllipsis: NonUndefined<InfiniteTableProps<T>['columnHeaderCssEllipsis']>;
     columnGroupsDepthsMap: InfiniteTableColumnGroupsDepthsMap;
@@ -536,6 +623,7 @@ declare type InfiniteTableColumnType<T> = {
     verticalAlign?: InfiniteTableColumn<T>['verticalAlign'];
     cssEllipsis?: boolean;
     headerCssEllipsis?: boolean;
+    field?: keyof T;
     components?: InfiniteTableColumn<T>['components'];
     renderValue?: InfiniteTableColumn<T>['renderValue'];
     render?: InfiniteTableColumn<T>['render'];
@@ -555,6 +643,18 @@ declare type InfiniteTableImperativeApi<T> = {
     setColumnOrder: (columnOrder: InfiniteTablePropColumnOrder) => void;
     setColumnVisibility: (columnVisibility: InfiniteTablePropColumnVisibility) => void;
     x?: T;
+    scrollRowIntoView: (rowIndex: number, config?: {
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offset?: number;
+    }) => void;
+    scrollColumnIntoView: (colId: string, config?: {
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offset?: number;
+    }) => void;
+    scrollCellIntoView: (rowIndex: number, colIdOrIndex: string | number, config?: {
+        scrollAdjustPosition?: ScrollAdjustPosition;
+        offset?: number;
+    }) => void;
     getState: () => InfiniteTableState<T>;
     getDataSourceState: () => DataSourceState<T>;
 };
@@ -661,6 +761,12 @@ interface InfiniteTableProps<T> {
     showZebraRows?: boolean;
     showHoverRows?: boolean;
     sortable?: boolean;
+    defaultActiveRowIndex?: number | null;
+    activeRowIndex?: number | null;
+    onActiveRowIndexChange?: (activeRowIndex: number) => void;
+    onActiveCellIndexChange?: (activeCellIndex: [number, number]) => void;
+    activeCellIndex?: [number, number] | null;
+    defaultActiveCellIndex?: [number, number] | null;
     draggableColumns?: boolean;
     header?: boolean;
     headerOptions?: InfiniteTablePropHeaderOptions;
@@ -676,8 +782,6 @@ interface InfiniteTableProps<T> {
     resizableColumns?: boolean;
     virtualizeColumns?: InfiniteTablePropVirtualizeColumns<T>;
     virtualizeRows?: boolean;
-    defaultActiveIndex?: number;
-    activeIndex?: number;
     onSelfFocus?: (event: React$1.FocusEvent<HTMLDivElement>) => void;
     onSelfBlur?: (event: React$1.FocusEvent<HTMLDivElement>) => void;
     onFocusWithin?: (event: React$1.FocusEvent<HTMLDivElement>) => void;
@@ -711,6 +815,7 @@ declare type Scrollbars = {
     vertical: boolean;
     horizontal: boolean;
 };
+declare type ScrollAdjustPosition = 'start' | 'end' | 'center';
 
 interface InfiniteTableComputedValues<T> {
     scrollbars: {
@@ -792,6 +897,7 @@ declare type InfiniteTableColumnRenderParamBase<DATA_TYPE, COL_TYPE = InfiniteTa
     value: string | number | Renderable;
     groupRowInfo: InfiniteTableRowInfo<DATA_TYPE> | null;
     rowIndex: number;
+    rowActive: boolean;
     column: COL_TYPE;
     toggleCurrentGroupRow: () => void;
     toggleGroupRow: InfiniteTableToggleGroupRowFn;
@@ -1255,6 +1361,7 @@ declare type DataSourceSingleSortInfo<T> = MultisortInfo<T> & {
 declare type DataSourceGroupBy<T> = GroupBy<T, any>;
 declare type DataSourcePivotBy<T> = PivotBy<T, any>;
 declare type DataSourceSortInfo<T> = null | DataSourceSingleSortInfo<T> | DataSourceSingleSortInfo<T>[];
+declare type DataSourcePropSortInfo<T> = DataSourceSortInfo<T>;
 declare type DataSourceRemoteData<T> = {
     data: T[] | LazyGroupDataItem<T>[];
     mappings?: DataSourceMappings;
@@ -1278,6 +1385,7 @@ interface DataSourceMappedState<T> {
     lazyLoad: DataSourceProps<T>['lazyLoad'];
     onDataParamsChange: DataSourceProps<T>['onDataParamsChange'];
     data: DataSourceProps<T>['data'];
+    sortMode: DataSourceProps<T>['sortMode'];
     filterFunction: DataSourceProps<T>['filterFunction'];
     filterValue: DataSourceProps<T>['filterValue'];
     filterTypes: NonUndefined<DataSourceProps<T>['filterTypes']>;
@@ -1399,7 +1507,8 @@ declare type DataSourceProps<T> = {
     livePaginationCursor?: DataSourcePropLivePaginationCursor<T>;
     onLivePaginationCursorChange?: (livePaginationCursor: DataSourceLivePaginationCursorValue) => void;
     filterFunction?: DataSourcePropFilterFunction<T>;
-    filterMode?: 'client' | 'server';
+    sortMode?: 'local' | 'remote';
+    filterMode?: 'local' | 'remote';
     filterValue?: DataSourcePropFilterValue<T>;
     defaultFilterValue?: DataSourcePropFilterValue<T>;
     onFilterValueChange?: (filterValue: DataSourcePropFilterValue<T>) => void;
@@ -1557,4 +1666,4 @@ declare const defaultFilterEditors: InfiniteTablePropFilterEditors<unknown>;
 declare function StringFilterEditor<T>(props: InfiniteTableFilterEditorProps<T>): JSX.Element;
 declare function NumberFilterEditor<T>(props: InfiniteTableFilterEditorProps<T>): JSX.Element;
 
-export { ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropLivePaginationCursor, DataSourcePropPivotBy, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableFilterEditorProps, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTableGroupColumnRenderIconFunction, InfiniteTableImperativeApi, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropColumnsMap, InfiniteTablePropComponents, InfiniteTablePropFilterEditors, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, NumberFilterEditor, Scrollbars, StringFilterEditor, debounce, defaultFilterEditors, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteHeaderCell };
+export { ColumnTypeWithInherit, DataSource, DataSourceAction, DataSourceActionType, DataSourceAggregationReducer, DataSourceComponentActions, DataSourceContextValue, DataSourceData, DataSourceDataParams, DataSourceDataParamsChanges, DataSourceDerivedState, DataSourceFilterFunctionParam, DataSourceFilterOperator, DataSourceFilterOperatorFunction, DataSourceFilterOperatorFunctionParam, DataSourceFilterType, DataSourceFilterValueItem, DataSourceFilterValueItemValueGetter, DataSourceGroupBy, DataSourceGroupRowsList, DataSourceLivePaginationCursorFn, DataSourceLivePaginationCursorParams, DataSourceLivePaginationCursorValue, DataSourceMappedState, DataSourceMappings, DataSourcePivotBy, DataSourcePropAggregationReducers, DataSourcePropFilterFunction, DataSourcePropFilterTypes, DataSourcePropFilterValue, DataSourcePropGroupBy, DataSourcePropGroupRowsStateObject, DataSourcePropLivePaginationCursor, DataSourcePropPivotBy, DataSourcePropSortInfo, DataSourcePropSortTypes, DataSourceProps, DataSourceReducer, DataSourceRemoteData, DataSourceSetupState, DataSourceSingleSortInfo, DataSourceSortInfo, DataSourceState, GroupRowsState, InfiniteTable, InfiniteTableAction, InfiniteTableActionType, InfiniteTableClassName, InfiniteTableColumn, InfiniteTableColumnAggregator, InfiniteTableColumnComparer, InfiniteTableColumnGroup, InfiniteTableColumnRenderParam, InfiniteTableColumnRenderValueParam, InfiniteTableColumnRowspanParam, InfiniteTableColumnSizingOptions, InfiniteTableComponent, InfiniteTableComputedColumn, InfiniteTableComputedValues, InfiniteTableContextValue, InfiniteTableFilterEditorProps, InfiniteTableGroupColumnBase, InfiniteTableGroupColumnFunction, InfiniteTableGroupColumnGetterOptions, InfiniteTableGroupColumnRenderIconFunction, InfiniteTableImperativeApi, InfiniteTablePivotColumn, InfiniteTablePropAutoSizeColumnsKey, InfiniteTablePropColumnGroups, InfiniteTablePropColumnOrder, InfiniteTablePropColumnPinning, InfiniteTablePropColumnSizing, InfiniteTablePropColumnTypes, InfiniteTablePropColumnVisibility, InfiniteTablePropColumns, InfiniteTablePropColumnsMap, InfiniteTablePropComponents, InfiniteTablePropFilterEditors, InfiniteTablePropGroupColumn, InfiniteTablePropGroupRenderStrategy, InfiniteTablePropHeaderOptions, InfiniteTablePropRowClassName, InfiniteTablePropRowStyle, InfiniteTableProps, InfiniteTableRowClassNameFn, InfiniteTableRowInfo, InfiniteTableRowStyleFn, InfiniteTableState, LazyGroupDataDeepMap, LazyGroupDataItem, LazyRowInfoGroup, NumberFilterEditor, Scrollbars, StringFilterEditor, debounce, defaultFilterEditors, defaultFilterTypes, defaultFilterTypes as filterTypes, flatten, getComponentStateRoot, group, interceptMap, multisort, useComponentState, useDataSource, useEffectWithChanges, useInfiniteColumnCell, useInfiniteHeaderCell };