deprecate MRT_Virtualizer type in favor of specific ones

Author: KevinVandy

apps/material-react-table-docs/examples/enable-column-virtualization/sandbox/src/TS.tsx

@@ -2,14 +2,13 @@ import { useRef } from 'react';
 import {
   MaterialReactTable,
   useMaterialReactTable,
-  type MRT_Virtualizer,
+  type MRT_ColumnVirtualizer,
 } from 'material-react-table';
 import { fakeColumns, fakeData } from './makeData';
 
 const Example = () => {
   //optionally access the underlying virtualizer instance
-  const columnVirtualizerInstanceRef =
-    useRef<MRT_Virtualizer<HTMLDivElement, HTMLTableCellElement>>(null);
+  const columnVirtualizerInstanceRef = useRef<MRT_ColumnVirtualizer>(null);
 
   const table = useMaterialReactTable({
     columnVirtualizerInstanceRef, //optional

apps/material-react-table-docs/examples/enable-row-virtualization/sandbox/src/TS.tsx

@@ -4,7 +4,7 @@ import {
   useMaterialReactTable,
   type MRT_ColumnDef,
   type MRT_SortingState,
-  type MRT_Virtualizer,
+  type MRT_RowVirtualizer,
 } from 'material-react-table';
 import { makeData, type Person } from './makeData';
 
@@ -58,8 +58,7 @@ const Example = () => {
   );
 
   //optionally access the underlying virtualizer instance
-  const rowVirtualizerInstanceRef =
-    useRef<MRT_Virtualizer<HTMLDivElement, HTMLTableRowElement>>(null);
+  const rowVirtualizerInstanceRef = useRef<MRT_RowVirtualizer>(null);
 
   const [data, setData] = useState<Person[]>([]);
   const [isLoading, setIsLoading] = useState(true);

apps/material-react-table-docs/examples/infinite-scrolling/sandbox/src/TS.tsx

@@ -12,7 +12,7 @@ import {
   type MRT_ColumnDef,
   type MRT_ColumnFiltersState,
   type MRT_SortingState,
-  type MRT_Virtualizer,
+  type MRT_RowVirtualizer,
 } from 'material-react-table';
 import { Typography } from '@mui/material';
 import {
@@ -64,8 +64,7 @@ const fetchSize = 25;
 
 const Example = () => {
   const tableContainerRef = useRef<HTMLDivElement>(null); //we can get access to the underlying TableContainer element and react to its scroll events
-  const rowVirtualizerInstanceRef =
-    useRef<MRT_Virtualizer<HTMLDivElement, HTMLTableRowElement>>(null); //we can get access to the underlying Virtualizer instance and call its scrollToIndex method
+  const rowVirtualizerInstanceRef = useRef<MRT_RowVirtualizer>(null); //we can get access to the underlying Virtualizer instance and call its scrollToIndex method
 
   const [columnFilters, setColumnFilters] = useState<MRT_ColumnFiltersState>(
     [],

apps/material-react-table-docs/examples/virtualized/sandbox/src/TS.tsx

@@ -4,7 +4,7 @@ import {
   useMaterialReactTable,
   type MRT_ColumnDef,
   type MRT_SortingState,
-  type MRT_Virtualizer,
+  type MRT_RowVirtualizer,
 } from 'material-react-table';
 import { makeData, type Person } from './makeData';
 
@@ -90,8 +90,7 @@ const Example = () => {
   );
 
   //optionally access the underlying virtualizer instance
-  const rowVirtualizerInstanceRef =
-    useRef<MRT_Virtualizer<HTMLDivElement, HTMLTableRowElement>>(null);
+  const rowVirtualizerInstanceRef = useRef<MRT_RowVirtualizer>(null);
 
   const [data, setData] = useState<Person[]>([]);
   const [isLoading, setIsLoading] = useState(true);

packages/material-react-table/src/types.ts

@@ -105,10 +105,7 @@ export type MRT_RowSelectionState = RowSelectionState;
 export type MRT_SortingState = SortingState;
 export type MRT_Updater<T> = Updater<T>;
 export type MRT_VirtualItem = VirtualItem;
-export type MRT_Virtualizer<
-  TScrollElement extends Element | Window = Element | Window,
-  TItemElement extends Element = Element,
-> = Virtualizer<TScrollElement, TItemElement>;
+
 export type MRT_VirtualizerOptions<
   TScrollElement extends Element | Window = Element | Window,
   TItemElement extends Element = Element,
@@ -131,6 +128,13 @@ export type MRT_RowVirtualizer<
   virtualRows: MRT_VirtualItem[];
 };
 
+/**
+ * @deprecated use `MRT_ColumnVirtualizer` or `MRT_RowVirtualizer` instead
+ */
+export type MRT_Virtualizer<_TScrollElement = any, _TItemElement = any> =
+  | MRT_ColumnVirtualizer
+  | MRT_RowVirtualizer;
+
 export type MRT_ColumnHelper<TData extends MRT_RowData> = {
   accessor: <
     TAccessor extends AccessorFn<TData> | DeepKeys<TData>,
@@ -750,7 +754,9 @@ export type MRT_TableOptions<TData extends MRT_RowData> = Omit<
   columnFilterModeOptions?: Array<
     LiteralUnion<string & MRT_FilterOption>
   > | null;
-  columnVirtualizerInstanceRef?: MutableRefObject<MRT_ColumnVirtualizer | null>;
+  columnVirtualizerInstanceRef?: MutableRefObject<
+    MRT_ColumnVirtualizer | MRT_Virtualizer | null
+  >;
   columnVirtualizerOptions?:
     | ((props: {
         table: MRT_TableInstance<TData>;
@@ -1184,7 +1190,9 @@ export type MRT_TableOptions<TData extends MRT_RowData> = Omit<
     | 'sticky'
     | 'top'
     | 'top-and-bottom';
-  rowVirtualizerInstanceRef?: MutableRefObject<MRT_RowVirtualizer | null>;
+  rowVirtualizerInstanceRef?: MutableRefObject<
+    MRT_RowVirtualizer | MRT_Virtualizer | null
+  >;
   rowVirtualizerOptions?:
     | ((props: {
         table: MRT_TableInstance<TData>;