material-react-table 3.0.2 → 3.1.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { MutableRefObject, Dispatch, SetStateAction, ReactNode, RefObject, ChangeEvent, MouseEvent, DragEventHandler } from 'react';
+import { RefObject, Dispatch, SetStateAction, ReactNode, JSX, ChangeEvent, MouseEvent, DragEventHandler } from 'react';
 import * as _tanstack_react_table from '@tanstack/react-table';
 import { Row, ColumnFiltersState, ColumnOrderState, ColumnPinningState, ColumnSizingInfoState, ColumnSizingState, ExpandedState, GroupingState, PaginationState, RowSelectionState, SortingState, Updater, VisibilityState, AccessorFn, DeepKeys, DeepValue, Table, TableState, ColumnDef, Column, Header, HeaderGroup, Cell, AggregationFn, SortingFn, FilterFn, TableOptions, OnChangeFn, Renderable, RowPinningPosition } from '@tanstack/react-table';
 import { VirtualItem, VirtualizerOptions, Virtualizer } from '@tanstack/react-virtual';
@@ -412,18 +412,18 @@ type MRT_TableInstance<TData extends MRT_RowData> = Omit<Table<TData>, 'getAllCo
     getTopRows: () => MRT_Row<TData>[];
     options: MRT_StatefulTableOptions<TData>;
     refs: {
-        actionCellRef: MutableRefObject<HTMLTableCellElement | null>;
-        bottomToolbarRef: MutableRefObject<HTMLDivElement | null>;
-        editInputRefs: MutableRefObject<Record<string, HTMLInputElement>>;
-        filterInputRefs: MutableRefObject<Record<string, HTMLInputElement>>;
-        lastSelectedRowId: MutableRefObject<null | string>;
-        searchInputRef: MutableRefObject<HTMLInputElement | null>;
-        tableContainerRef: MutableRefObject<HTMLDivElement | null>;
-        tableFooterRef: MutableRefObject<HTMLTableSectionElement | null>;
-        tableHeadCellRefs: MutableRefObject<Record<string, HTMLTableCellElement>>;
-        tableHeadRef: MutableRefObject<HTMLTableSectionElement | null>;
-        tablePaperRef: MutableRefObject<HTMLDivElement | null>;
-        topToolbarRef: MutableRefObject<HTMLDivElement | null>;
+        actionCellRef: RefObject<HTMLTableCellElement | null>;
+        bottomToolbarRef: RefObject<HTMLDivElement | null>;
+        editInputRefs: RefObject<Record<string, HTMLInputElement> | null>;
+        filterInputRefs: RefObject<Record<string, HTMLInputElement> | null>;
+        lastSelectedRowId: RefObject<null | string>;
+        searchInputRef: RefObject<HTMLInputElement | null>;
+        tableContainerRef: RefObject<HTMLDivElement | null>;
+        tableFooterRef: RefObject<HTMLTableSectionElement | null>;
+        tableHeadCellRefs: RefObject<Record<string, HTMLTableCellElement> | null>;
+        tableHeadRef: RefObject<HTMLTableSectionElement | null>;
+        tablePaperRef: RefObject<HTMLDivElement | null>;
+        topToolbarRef: RefObject<HTMLDivElement | null>;
     };
     setActionCell: Dispatch<SetStateAction<MRT_Cell<TData> | null>>;
     setColumnFilterFns: Dispatch<SetStateAction<MRT_ColumnFilterFnsState>>;
@@ -504,7 +504,7 @@ interface MRT_ColumnDef<TData extends MRT_RowData, TValue = unknown> extends Omi
         column: MRT_Column<TData, TValue>;
         renderedCellValue: ReactNode;
         row: MRT_Row<TData>;
-        rowRef?: RefObject<HTMLTableRowElement>;
+        rowRef?: RefObject<HTMLTableRowElement | null>;
         staticColumnIndex?: number;
         staticRowIndex?: number;
         table: MRT_TableInstance<TData>;
@@ -757,7 +757,7 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
      * @link https://www.material-react-table.com/docs/api/column-options
      */
     columns: MRT_ColumnDef<TData, any>[];
-    columnVirtualizerInstanceRef?: MutableRefObject<MRT_ColumnVirtualizer | null>;
+    columnVirtualizerInstanceRef?: RefObject<MRT_ColumnVirtualizer | null>;
     columnVirtualizerOptions?: ((props: {
         table: MRT_TableInstance<TData>;
     }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>>) | Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>>;
@@ -849,23 +849,14 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
     }) | (CircularProgressProps & {
         Component?: ReactNode;
     });
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiColumnActionsButtonProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => IconButtonProps) | IconButtonProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiColumnDragHandleProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => IconButtonProps) | IconButtonProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiCopyButtonProps?: ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
@@ -884,9 +875,6 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => DialogProps) | DialogProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiEditTextFieldProps?: ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
@@ -901,54 +889,33 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
         staticRowIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => IconButtonProps) | IconButtonProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterAutocompleteProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => AutocompleteProps<any, any, any, any>) | AutocompleteProps<any, any, any, any>;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterCheckboxProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => CheckboxProps) | CheckboxProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterDatePickerProps?: ((props: {
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => DatePickerProps<never>) | DatePickerProps<never>;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterDateTimePickerProps?: ((props: {
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => DateTimePickerProps<never>) | DateTimePickerProps<never>;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterSliderProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => SliderProps) | SliderProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterTextFieldProps?: ((props: {
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => TextFieldProps) | TextFieldProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiFilterTimePickerProps?: ((props: {
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
@@ -998,9 +965,6 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => SkeletonProps) | SkeletonProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiTableBodyCellProps?: ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
@@ -1019,9 +983,6 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
     muiTableContainerProps?: ((props: {
         table: MRT_TableInstance<TData>;
     }) => TableContainerProps) | TableContainerProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiTableFooterCellProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
@@ -1033,9 +994,6 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
         footerGroup: MRT_HeaderGroup<TData>;
         table: MRT_TableInstance<TData>;
     }) => TableRowProps) | TableRowProps;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     muiTableHeadCellProps?: ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
@@ -1117,9 +1075,6 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
     renderCaption?: ((props: {
         table: MRT_TableInstance<TData>;
     }) => ReactNode) | ReactNode;
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     renderCellActionMenuItems?: (props: {
         cell: MRT_Cell<TData>;
         closeMenu: () => void;
@@ -1130,18 +1085,12 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
         staticRowIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => ReactNode[];
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     renderColumnActionsMenuItems?: (props: {
         closeMenu: () => void;
         column: MRT_Column<TData>;
         internalColumnMenuItems: ReactNode[];
         table: MRT_TableInstance<TData>;
     }) => ReactNode[];
-    /**
-     * @deprecated Specify this in the `defaultColumn` table option instead if you want to apply to all columns.
-     */
     renderColumnFilterModeMenuItems?: (props: {
         column: MRT_Column<TData>;
         internalFilterOptions: MRT_InternalFilterOption[];
@@ -1198,7 +1147,7 @@ interface MRT_TableOptions<TData extends MRT_RowData> extends Omit<Partial<Table
     }) => ReactNode;
     rowNumberDisplayMode?: 'original' | 'static';
     rowPinningDisplayMode?: 'bottom' | 'select-bottom' | 'select-sticky' | 'select-top' | 'sticky' | 'top' | 'top-and-bottom';
-    rowVirtualizerInstanceRef?: MutableRefObject<MRT_RowVirtualizer | null>;
+    rowVirtualizerInstanceRef?: RefObject<MRT_RowVirtualizer | null>;
     rowVirtualizerOptions?: ((props: {
         table: MRT_TableInstance<TData>;
     }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>) | Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>;
@@ -1302,7 +1251,7 @@ declare function defaultDisplayColumnProps<TData extends MRT_RowData>({ header,
         column: MRT_Column<TData, unknown>;
         renderedCellValue: react.ReactNode;
         row: MRT_Row<TData>;
-        rowRef?: react.RefObject<HTMLTableRowElement>;
+        rowRef?: react.RefObject<HTMLTableRowElement | null>;
         staticColumnIndex?: number;
         staticRowIndex?: number;
         table: MRT_TableInstance<TData>;
@@ -1534,7 +1483,7 @@ declare const Memo_MRT_TableBody: typeof MRT_TableBody;
 interface MRT_TableBodyCellProps<TData extends MRT_RowData> extends TableCellProps {
     cell: MRT_Cell<TData>;
     numRows?: number;
-    rowRef: RefObject<HTMLTableRowElement>;
+    rowRef: RefObject<HTMLTableRowElement | null>;
     staticColumnIndex?: number;
     staticRowIndex: number;
     table: MRT_TableInstance<TData>;
@@ -1544,7 +1493,7 @@ declare const Memo_MRT_TableBodyCell: typeof MRT_TableBodyCell;
 
 interface MRT_TableBodyCellValueProps<TData extends MRT_RowData> {
     cell: MRT_Cell<TData>;
-    rowRef?: RefObject<HTMLTableRowElement>;
+    rowRef?: RefObject<HTMLTableRowElement | null>;
     staticColumnIndex?: number;
     staticRowIndex?: number;
     table: MRT_TableInstance<TData>;
@@ -1566,7 +1515,7 @@ declare const Memo_MRT_TableBodyRow: typeof MRT_TableBodyRow;
 
 interface MRT_TableBodyRowGrabHandleProps<TData extends MRT_RowData> extends IconButtonProps {
     row: MRT_Row<TData>;
-    rowRef: RefObject<HTMLTableRowElement>;
+    rowRef: RefObject<HTMLTableRowElement | null>;
     table: MRT_TableInstance<TData>;
 }
 declare const MRT_TableBodyRowGrabHandle: <TData extends MRT_RowData>({ row, rowRef, table, ...rest }: MRT_TableBodyRowGrabHandleProps<TData>) => react_jsx_runtime.JSX.Element;
@@ -1578,7 +1527,7 @@ interface MRT_TableBodyRowPinButtonProps<TData extends MRT_RowData> extends Icon
 declare const MRT_TableBodyRowPinButton: <TData extends MRT_RowData>({ row, table, ...rest }: MRT_TableBodyRowPinButtonProps<TData>) => react_jsx_runtime.JSX.Element | null;
 
 interface MRT_TableDetailPanelProps<TData extends MRT_RowData> extends TableCellProps {
-    parentRowRef: RefObject<HTMLTableRowElement>;
+    parentRowRef: RefObject<HTMLTableRowElement | null>;
     row: MRT_Row<TData>;
     rowVirtualizer?: MRT_RowVirtualizer;
     staticRowIndex: number;
@@ -1722,7 +1671,7 @@ declare const MRT_TableHeadCellFilterLabel: <TData extends MRT_RowData = {}>({ h
 interface MRT_TableHeadCellGrabHandleProps<TData extends MRT_RowData> extends IconButtonProps {
     column: MRT_Column<TData>;
     table: MRT_TableInstance<TData>;
-    tableHeadCellRef: RefObject<HTMLTableCellElement>;
+    tableHeadCellRef: RefObject<HTMLTableCellElement | null>;
 }
 declare const MRT_TableHeadCellGrabHandle: <TData extends MRT_RowData>({ column, table, tableHeadCellRef, ...rest }: MRT_TableHeadCellGrabHandleProps<TData>) => react_jsx_runtime.JSX.Element;