@mui/x-virtualizer 0.1.0

package/esm/features/rowspan.d.ts

@@ -0,0 +1,25 @@
+import { Store } from '@mui/x-internals/store';
+import type { BaseState, VirtualizerParams } from "../useVirtualizer.js";
+import type { RowSpanningState } from "../models/rowspan.js";
+import { Virtualization } from "./virtualization.js";
+export declare const Rowspan: {
+  initialize: typeof initializeState;
+  use: typeof useRowspan;
+  selectors: {
+    state: (state: Rowspan.State) => RowSpanningState;
+    hiddenCells: (state: Rowspan.State) => Record<any, Record<number, boolean>>;
+    spannedCells: (state: Rowspan.State) => Record<any, Record<number, number>>;
+    hiddenCellsOriginMap: (state: Rowspan.State) => Record<number, Record<number, number>>;
+  };
+};
+export declare namespace Rowspan {
+  type State = {
+    rowSpanning: RowSpanningState;
+  };
+  type API = ReturnType<typeof useRowspan>;
+}
+declare function initializeState(params: VirtualizerParams): Rowspan.State;
+declare function useRowspan(store: Store<BaseState & Rowspan.State>, _params: VirtualizerParams, _api: Virtualization.API): {
+  getHiddenCellsOrigin: () => Record<number, Record<number, number>>;
+};
+export {};

package/esm/features/rowspan.js

@@ -0,0 +1,36 @@
+/* eslint-disable import/export, @typescript-eslint/no-redeclare */
+
+const EMPTY_RANGE = {
+  firstRowIndex: 0,
+  lastRowIndex: 0
+};
+const EMPTY_CACHES = {
+  spannedCells: {},
+  hiddenCells: {},
+  hiddenCellOriginMap: {}
+};
+const selectors = {
+  state: state => state.rowSpanning,
+  hiddenCells: state => state.rowSpanning.caches.hiddenCells,
+  spannedCells: state => state.rowSpanning.caches.spannedCells,
+  hiddenCellsOriginMap: state => state.rowSpanning.caches.hiddenCellOriginMap
+};
+export const Rowspan = {
+  initialize: initializeState,
+  use: useRowspan,
+  selectors
+};
+function initializeState(params) {
+  return {
+    rowSpanning: params.initialState?.rowSpanning ?? {
+      caches: EMPTY_CACHES,
+      processedRange: EMPTY_RANGE
+    }
+  };
+}
+function useRowspan(store, _params, _api) {
+  const getHiddenCellsOrigin = () => selectors.hiddenCellsOriginMap(store.state);
+  return {
+    getHiddenCellsOrigin
+  };
+}

package/esm/features/virtualization.d.ts

@@ -0,0 +1,103 @@
+import * as React from 'react';
+import type { integer } from '@mui/x-internals/types';
+import { Store } from '@mui/x-internals/store';
+import type { CellColSpanInfo } from "../models/colspan.js";
+import { Dimensions } from "./dimensions.js";
+import type { BaseState, VirtualizerParams } from "../useVirtualizer.js";
+import { PinnedRowPosition, RenderContext, ColumnsRenderContext, ColumnWithWidth, RowId, RowEntry } from "../models/index.js";
+export type VirtualizationState = {
+  enabled: boolean;
+  enabledForRows: boolean;
+  enabledForColumns: boolean;
+  renderContext: RenderContext;
+};
+export declare const EMPTY_RENDER_CONTEXT: {
+  firstRowIndex: number;
+  lastRowIndex: number;
+  firstColumnIndex: number;
+  lastColumnIndex: number;
+};
+export declare const Virtualization: {
+  initialize: typeof initializeState;
+  use: typeof useVirtualization;
+  selectors: {
+    renderContext: (state: BaseState) => RenderContext;
+    enabledForRows: (state: BaseState) => boolean;
+    enabledForColumns: (state: BaseState) => boolean;
+  };
+};
+export declare namespace Virtualization {
+  type State = {
+    virtualization: VirtualizationState;
+    getters: ReturnType<typeof useVirtualization>['getters'];
+  };
+  type API = ReturnType<typeof useVirtualization>;
+}
+declare function initializeState(params: VirtualizerParams): Virtualization.State;
+/** APIs to override for colspan/rowspan */
+type AbstractAPI = {
+  getCellColSpanInfo: (rowId: RowId, columnIndex: integer) => CellColSpanInfo;
+  calculateColSpan: (rowId: RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
+  getHiddenCellsOrigin: () => Record<RowId, Record<number, number>>;
+};
+type RequiredAPI = Dimensions.API & AbstractAPI;
+declare function useVirtualization(store: Store<BaseState>, params: VirtualizerParams, api: RequiredAPI): {
+  getters: {
+    setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
+    getRows: (rowParams: {
+      rows?: RowEntry[];
+      position?: PinnedRowPosition;
+      renderContext?: RenderContext;
+    } | undefined, unstable_rowTree: Record<RowId, any>) => React.ReactNode[];
+    getContainerProps: () => {
+      ref: React.RefObject<HTMLDivElement | null>;
+    };
+    getScrollerProps: () => {
+      ref: React.RefObject<HTMLDivElement | null>;
+      onScroll: () => void;
+      onWheel: ((event: React.WheelEvent) => void) | undefined;
+      onTouchMove: ((event: React.TouchEvent) => void) | undefined;
+      style: React.CSSProperties;
+      role: string;
+      tabIndex: number | undefined;
+    };
+    getContentProps: () => {
+      style: React.CSSProperties;
+      role: string;
+      ref: (node: HTMLDivElement | null) => void;
+    };
+    getRenderZoneProps: () => {
+      role: string;
+    };
+    getScrollbarVerticalProps: () => {
+      ref: React.RefObject<HTMLDivElement | null>;
+      scrollPosition: React.RefObject<{
+        top: number;
+        left: number;
+      }>;
+    };
+    getScrollbarHorizontalProps: () => {
+      ref: React.RefObject<HTMLDivElement | null>;
+      scrollPosition: React.RefObject<{
+        top: number;
+        left: number;
+      }>;
+    };
+    getScrollAreaProps: () => {
+      scrollPosition: React.RefObject<{
+        top: number;
+        left: number;
+      }>;
+    };
+  };
+  useVirtualization: () => BaseState;
+  setPanels: React.Dispatch<React.SetStateAction<Readonly<Map<any, React.ReactNode>>>>;
+  forceUpdateRenderContext: () => void;
+  getCellColSpanInfo: (rowId: RowId, columnIndex: integer) => CellColSpanInfo;
+  calculateColSpan: (rowId: RowId, minFirstColumn: integer, maxLastColumn: integer, columns: ColumnWithWidth[]) => void;
+  getHiddenCellsOrigin: () => Record<RowId, Record<number, number>>;
+};
+export declare function areRenderContextsEqual(context1: RenderContext, context2: RenderContext): boolean;
+export declare function computeOffsetLeft(columnPositions: number[], renderContext: ColumnsRenderContext, pinnedLeftLength: number): number;
+export declare function roundToDecimalPlaces(value: number, decimals: number): number;
+export {};