material-react-table 1.14.0 → 2.0.0-alpha.0

package/dist/esm/types/types.d.ts

@@ -1,14 +1,15 @@
-import { type Dispatch, type MutableRefObject, type ReactNode, type SetStateAction } from 'react';
+import { type Dispatch, type MutableRefObject, type ReactNode, type RefObject, type SetStateAction } from 'react';
 import { type AlertProps } from '@mui/material/Alert';
 import { type ButtonProps } from '@mui/material/Button';
 import { type CheckboxProps } from '@mui/material/Checkbox';
 import { type ChipProps } from '@mui/material/Chip';
+import { type DialogProps } from '@mui/material/Dialog';
 import { type IconButtonProps } from '@mui/material/IconButton';
 import { type LinearProgressProps } from '@mui/material/LinearProgress';
 import { type PaperProps } from '@mui/material/Paper';
 import { type RadioProps } from '@mui/material/Radio';
 import { type SkeletonProps } from '@mui/material/Skeleton';
-import { type SliderProps } from '@mui/material';
+import { type SliderProps } from '@mui/material/Slider';
 import { type TableBodyProps } from '@mui/material/TableBody';
 import { type TableCellProps } from '@mui/material/TableCell';
 import { type TableContainerProps } from '@mui/material/TableContainer';
@@ -26,12 +27,17 @@ import { type MRT_FilterFns } from './filterFns';
 import { type MRT_SortingFns } from './sortingFns';
 import { type MRT_Icons } from './icons';
 export type { MRT_Icons };
-type Prettify<T> = {
+export type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+export type Prettify<T> = {
     [K in keyof T]: T[K];
-} & {};
-type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
+} & unknown;
+export type Xor<A, B> = Prettify<A & {
+    [k in keyof B]?: never;
+}> | Prettify<B & {
+    [k in keyof A]?: never;
+}>;
 export type MRT_DensityState = 'comfortable' | 'compact' | 'spacious';
-export type MRT_FilterFnsState = Record<string, MRT_FilterOption>;
+export type MRT_ColumnFilterFnsState = Record<string, MRT_FilterOption>;
 export type { ColumnFiltersState as MRT_ColumnFiltersState, ColumnOrderState as MRT_ColumnOrderState, ColumnPinningState as MRT_ColumnPinningState, ColumnSizingInfoState as MRT_ColumnSizingInfoState, ColumnSizingState as MRT_ColumnSizingState, ExpandedState as MRT_ExpandedState, GroupingState as MRT_GroupingState, PaginationState as MRT_PaginationState, RowSelectionState as MRT_RowSelectionState, SortingState as MRT_SortingState, Updater as MRT_Updater, VirtualItem as MRT_VirtualItem, Virtualizer as MRT_Virtualizer, VirtualizerOptions as MRT_VirtualizerOptions, VisibilityState as MRT_VisibilityState, };
 export interface MRT_Localization {
     actions: string;
@@ -43,6 +49,7 @@ export interface MRT_Localization {
     clearSearch: string;
     clearSort: string;
     clickToCopy: string;
+    create?: string;
     collapse: string;
     collapseAll: string;
     columnActions: string;
@@ -122,16 +129,15 @@ export interface MRT_Localization {
     ungroupByColumn: string;
     unpin: string;
     unpinAll: string;
-    unsorted: string;
 }
-export interface MRT_RowModel<TData extends Record<string, any> = {}> {
+export interface MRT_RowModel<TData extends Record<string, any>> {
     flatRows: MRT_Row<TData>[];
     rows: MRT_Row<TData>[];
     rowsById: {
         [key: string]: MRT_Row<TData>;
     };
 }
-export type MRT_TableInstance<TData extends Record<string, any> = {}> = Prettify<Omit<Table<TData>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getCenterLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getLeftLeafColumns' | 'getPaginationRowModel' | 'getPreFilteredRowModel' | 'getPrePaginationRowModel' | 'getRightLeafColumns' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
+export type MRT_TableInstance<TData extends Record<string, any>> = Omit<Table<TData>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getCenterLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getHeaderGroups' | 'getLeftLeafColumns' | 'getPaginationRowModel' | 'getPreFilteredRowModel' | 'getPrePaginationRowModel' | 'getRightLeafColumns' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
     getAllColumns: () => MRT_Column<TData>[];
     getAllFlatColumns: () => MRT_Column<TData>[];
     getAllLeafColumns: () => MRT_Column<TData>[];
@@ -139,6 +145,7 @@ export type MRT_TableInstance<TData extends Record<string, any> = {}> = Prettify
     getColumn: (columnId: string) => MRT_Column<TData>;
     getExpandedRowModel: () => MRT_RowModel<TData>;
     getFlatHeaders: () => MRT_Header<TData>[];
+    getHeaderGroups: () => MRT_HeaderGroup<TData>[];
     getLeftLeafColumns: () => MRT_Column<TData>[];
     getPaginationRowModel: () => MRT_RowModel<TData>;
     getPreFilteredRowModel: () => MRT_RowModel<TData>;
@@ -147,10 +154,7 @@ export type MRT_TableInstance<TData extends Record<string, any> = {}> = Prettify
     getRowModel: () => MRT_RowModel<TData>;
     getSelectedRowModel: () => MRT_RowModel<TData>;
     getState: () => MRT_TableState<TData>;
-    options: MaterialReactTableProps<TData> & {
-        icons: MRT_Icons;
-        localization: MRT_Localization;
-    };
+    options: MRT_DefinedTableOptions<TData>;
     refs: {
         bottomToolbarRef: MutableRefObject<HTMLDivElement>;
         editInputRefs: MutableRefObject<Record<string, HTMLInputElement>>;
@@ -161,7 +165,8 @@ export type MRT_TableInstance<TData extends Record<string, any> = {}> = Prettify
         tablePaperRef: MutableRefObject<HTMLDivElement>;
         topToolbarRef: MutableRefObject<HTMLDivElement>;
     };
-    setColumnFilterFns: Dispatch<SetStateAction<MRT_FilterFnsState>>;
+    setCreatingRow: Dispatch<SetStateAction<MRT_Row<TData> | null | true>>;
+    setColumnFilterFns: Dispatch<SetStateAction<MRT_ColumnFilterFnsState>>;
     setDensity: Dispatch<SetStateAction<MRT_DensityState>>;
     setDraggingColumn: Dispatch<SetStateAction<MRT_Column<TData> | null>>;
     setDraggingRow: Dispatch<SetStateAction<MRT_Row<TData> | null>>;
@@ -179,9 +184,14 @@ export type MRT_TableInstance<TData extends Record<string, any> = {}> = Prettify
     setShowColumnFilters: Dispatch<SetStateAction<boolean>>;
     setShowGlobalFilter: Dispatch<SetStateAction<boolean>>;
     setShowToolbarDropZone: Dispatch<SetStateAction<boolean>>;
-}>;
-export type MRT_TableState<TData extends Record<string, any> = {}> = Prettify<TableState & {
-    columnFilterFns: MRT_FilterFnsState;
+};
+export type MRT_DefinedTableOptions<TData extends Record<string, any>> = MRT_TableOptions<TData> & {
+    localization: MRT_Localization;
+    icons: MRT_Icons;
+};
+export type MRT_TableState<TData extends Record<string, any>> = TableState & {
+    columnFilterFns: MRT_ColumnFilterFnsState;
+    creatingRow: MRT_Row<TData> | null;
     density: MRT_DensityState;
     draggingColumn: MRT_Column<TData> | null;
     draggingRow: MRT_Row<TData> | null;
@@ -196,14 +206,15 @@ export type MRT_TableState<TData extends Record<string, any> = {}> = Prettify<Ta
     } | null;
     isFullScreen: boolean;
     isLoading: boolean;
+    isSaving: boolean;
     showAlertBanner: boolean;
     showColumnFilters: boolean;
     showGlobalFilter: boolean;
     showProgressBars: boolean;
     showSkeletons: boolean;
     showToolbarDropZone: boolean;
-}>;
-export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'aggregatedCell' | 'aggregationFn' | 'cell' | 'columns' | 'filterFn' | 'footer' | 'header' | 'id' | 'sortingFn'> & {
+};
+export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'aggregatedCell' | 'aggregationFn' | 'cell' | 'columns' | 'filterFn' | 'footer' | 'header' | 'id' | 'sortingFn'> & {
     AggregatedCell?: (props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
@@ -215,6 +226,7 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnD
         renderedCellValue: number | string | ReactNode;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
+        rowRef?: RefObject<HTMLTableRowElement>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Edit?: (props: {
@@ -266,7 +278,7 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnD
      * @example accessorKey: 'username' //simple
      * @example accessorKey: 'name.firstName' //deep key dot notation
      */
-    accessorKey?: DeepKeys<TData>;
+    accessorKey?: (string & {}) | DeepKeys<TData>;
     aggregationFn?: MRT_AggregationFn<TData> | Array<MRT_AggregationFn<TData>>;
     /**
      * Specify what type of column this is. Either `data`, `display`, or `group`. Defaults to `data`.
@@ -315,13 +327,13 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnD
      * @default gets set to the same value as `accessorKey` by default
      */
     id?: LiteralUnion<string & keyof TData>;
-    muiTableBodyCellCopyButtonProps?: ButtonProps | ((props: {
+    muiCopyButtonProps?: ButtonProps | ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ButtonProps);
-    muiTableBodyCellEditTextFieldProps?: TextFieldProps | ((props: {
+    muiEditTextFieldProps?: TextFieldProps | ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
@@ -337,24 +349,24 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnD
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => TableCellProps);
-    muiTableHeadCellColumnActionsButtonProps?: IconButtonProps | ((props: {
+    muiColumnActionsButtonProps?: IconButtonProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => IconButtonProps);
-    muiTableHeadCellDragHandleProps?: IconButtonProps | ((props: {
+    muiColumnDragHandleProps?: IconButtonProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => IconButtonProps);
-    muiTableHeadCellFilterCheckboxProps?: CheckboxProps | ((props: {
+    muiFilterCheckboxProps?: CheckboxProps | ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => CheckboxProps);
-    muiTableHeadCellFilterTextFieldProps?: TextFieldProps | ((props: {
+    muiFilterTextFieldProps?: TextFieldProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
     }) => TextFieldProps);
-    muiTableHeadCellFilterSliderProps?: SliderProps | ((props: {
+    muiFilterSliderProps?: SliderProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => TextFieldProps);
@@ -376,40 +388,40 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnD
     }) => ReactNode[];
     sortingFn?: MRT_SortingFn<TData>;
 };
-export type MRT_DefinedColumnDef<TData extends Record<string, any> = {}> = Omit<MRT_ColumnDef<TData>, 'id' | 'defaultDisplayColumn'> & {
+export type MRT_DefinedColumnDef<TData extends Record<string, any>> = Omit<MRT_ColumnDef<TData>, 'id' | 'defaultDisplayColumn'> & {
     defaultDisplayColumn: Partial<MRT_ColumnDef<TData>>;
     id: string;
     _filterFn: MRT_FilterOption;
 };
-export type MRT_Column<TData extends Record<string, any> = {}> = Omit<Column<TData, unknown>, 'header' | 'footer' | 'columns' | 'columnDef' | 'filterFn'> & {
+export type MRT_Column<TData extends Record<string, any>> = Omit<Column<TData, unknown>, 'header' | 'footer' | 'columns' | 'columnDef' | 'filterFn'> & {
     columnDef: MRT_DefinedColumnDef<TData>;
     columns?: MRT_Column<TData>[];
     filterFn?: MRT_FilterFn<TData>;
     footer: string;
     header: string;
 };
-export type MRT_Header<TData extends Record<string, any> = {}> = Prettify<Omit<Header<TData, unknown>, 'column'> & {
+export type MRT_Header<TData extends Record<string, any>> = Omit<Header<TData, unknown>, 'column'> & {
     column: MRT_Column<TData>;
-}>;
-export type MRT_HeaderGroup<TData extends Record<string, any> = {}> = Prettify<Omit<HeaderGroup<TData>, 'headers'> & {
+};
+export type MRT_HeaderGroup<TData extends Record<string, any>> = Omit<HeaderGroup<TData>, 'headers'> & {
     headers: MRT_Header<TData>[];
-}>;
-export type MRT_Row<TData extends Record<string, any> = {}> = Prettify<Omit<Row<TData>, 'getVisibleCells' | 'getAllCells' | 'subRows' | '_valuesCache'> & {
+};
+export type MRT_Row<TData extends Record<string, any>> = Omit<Row<TData>, 'getVisibleCells' | 'getAllCells' | 'subRows' | '_valuesCache'> & {
     getAllCells: () => MRT_Cell<TData>[];
     getVisibleCells: () => MRT_Cell<TData>[];
     subRows?: MRT_Row<TData>[];
     _valuesCache: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
-}>;
-export type MRT_Cell<TData extends Record<string, any> = {}> = Prettify<Omit<Cell<TData, unknown>, 'column' | 'row'> & {
+};
+export type MRT_Cell<TData extends Record<string, any>> = Omit<Cell<TData, unknown>, 'column' | 'row'> & {
     column: MRT_Column<TData>;
     row: MRT_Row<TData>;
-}>;
+};
 export type MRT_AggregationOption = string & keyof typeof MRT_AggregationFns;
-export type MRT_AggregationFn<TData extends Record<string, any> = {}> = AggregationFn<TData> | MRT_AggregationOption;
+export type MRT_AggregationFn<TData extends Record<string, any>> = AggregationFn<TData> | MRT_AggregationOption;
 export type MRT_SortingOption = LiteralUnion<string & keyof typeof MRT_SortingFns>;
-export type MRT_SortingFn<TData extends Record<string, any> = {}> = SortingFn<TData> | MRT_SortingOption;
+export type MRT_SortingFn<TData extends Record<string, any>> = SortingFn<TData> | MRT_SortingOption;
 export type MRT_FilterOption = LiteralUnion<string & keyof typeof MRT_FilterFns>;
-export type MRT_FilterFn<TData extends Record<string, any> = {}> = FilterFn<TData> | MRT_FilterOption;
+export type MRT_FilterFn<TData extends Record<string, any>> = FilterFn<TData> | MRT_FilterOption;
 export type MRT_InternalFilterOption = {
     option: string;
     symbol: string;
@@ -417,7 +429,6 @@ export type MRT_InternalFilterOption = {
     divider: boolean;
 };
 export type MRT_DisplayColumnIds = 'mrt-row-actions' | 'mrt-row-drag' | 'mrt-row-expand' | 'mrt-row-numbers' | 'mrt-row-select';
-export type MRT_CreateTableFeature<TData extends Record<string, any> = {}, TFeature = any> = (table: MRT_TableInstance<TData>) => TFeature;
 /**
  * `columns` and `data` props are the only required props, but there are over 170 other optional props.
  *
@@ -427,7 +438,7 @@ export type MRT_CreateTableFeature<TData extends Record<string, any> = {}, TFeat
  * See the full props list on the official docs site:
  * @link https://www.material-react-table.com/docs/api/props
  */
-export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Prettify<Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'defaultColumn' | 'enableRowSelection' | 'expandRowsFn' | 'getRowId' | 'globalFilterFn' | 'initialState' | 'onStateChange' | 'state'> & {
+export type MRT_TableOptions<TData extends Record<string, any>> = Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'defaultColumn' | 'enableRowSelection' | 'expandRowsFn' | 'getRowId' | 'globalFilterFn' | 'initialState' | 'onStateChange' | 'state'> & {
     columnFilterModeOptions?: Array<LiteralUnion<string & MRT_FilterOption>> | null;
     /**
      * The columns to display in the table. `accessorKey`s or `accessorFn`s must match keys in the `data` prop.
@@ -440,6 +451,10 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
      * @link https://www.material-react-table.com/docs/api/column-options
      */
     columns: MRT_ColumnDef<TData>[];
+    columnVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, HTMLTableCellElement> | null>;
+    columnVirtualizerOptions?: Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>> | ((props: {
+        table: MRT_TableInstance<TData>;
+    }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>>);
     /**
      * Pass your data as an array of objects. Objects can theoretically be any shape, but it's best to keep them consistent.
      *
@@ -456,9 +471,13 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
      */
     defaultDisplayColumn?: Partial<MRT_ColumnDef<TData>>;
     displayColumnDefOptions?: Partial<{
-        [key in MRT_DisplayColumnIds]: Partial<MRT_ColumnDef>;
+        [key in MRT_DisplayColumnIds]: Partial<MRT_ColumnDef<TData>>;
     }>;
-    editingMode?: 'table' | 'modal' | 'row' | 'cell';
+    createDisplayMode?: 'modal' | 'row' | 'custom';
+    editDisplayMode?: 'modal' | 'row' | 'cell' | 'table' | 'custom';
+    columnFilterDisplayMode?: 'subheader' | 'popover' | 'custom';
+    paginationDisplayMode?: 'default' | 'pages' | 'custom';
+    selectDisplayMode?: 'checkbox' | 'radio' | 'switch';
     enableBottomToolbar?: boolean;
     enableClickToCopy?: boolean;
     enableColumnActions?: boolean;
@@ -536,13 +555,13 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
         table: MRT_TableInstance<TData>;
         row: MRT_Row<TData>;
     }) => CheckboxProps | RadioProps);
-    muiTableBodyCellCopyButtonProps?: ButtonProps | ((props: {
+    muiCopyButtonProps?: ButtonProps | ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ButtonProps);
-    muiTableBodyCellEditTextFieldProps?: TextFieldProps | ((props: {
+    muiEditTextFieldProps?: TextFieldProps | ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
@@ -554,7 +573,7 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => TableCellProps);
-    muiTableBodyCellSkeletonProps?: SkeletonProps | ((props: {
+    muiSkeletonProps?: SkeletonProps | ((props: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
@@ -563,7 +582,7 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
     muiTableBodyProps?: TableBodyProps | ((props: {
         table: MRT_TableInstance<TData>;
     }) => TableBodyProps);
-    muiTableBodyRowDragHandleProps?: IconButtonProps | ((props: {
+    muiRowDragHandleProps?: IconButtonProps | ((props: {
         table: MRT_TableInstance<TData>;
         row: MRT_Row<TData>;
     }) => IconButtonProps);
@@ -576,7 +595,7 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
     muiTableContainerProps?: TableContainerProps | ((props: {
         table: MRT_TableInstance<TData>;
     }) => TableContainerProps);
-    muiTableDetailPanelProps?: TableCellProps | ((props: {
+    muiDetailPanelProps?: TableCellProps | ((props: {
         table: MRT_TableInstance<TData>;
         row: MRT_Row<TData>;
     }) => TableCellProps);
@@ -591,27 +610,35 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
         table: MRT_TableInstance<TData>;
         footerGroup: MRT_HeaderGroup<TData>;
     }) => TableRowProps);
-    muiTableHeadCellColumnActionsButtonProps?: IconButtonProps | ((props: {
+    muiColumnActionsButtonProps?: IconButtonProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => IconButtonProps);
-    muiTableHeadCellDragHandleProps?: IconButtonProps | ((props: {
+    muiColumnDragHandleProps?: IconButtonProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => IconButtonProps);
-    muiTableHeadCellFilterCheckboxProps?: CheckboxProps | ((props: {
+    muiFilterCheckboxProps?: CheckboxProps | ((props: {
         column: MRT_Column<TData>;
         table: MRT_TableInstance<TData>;
     }) => CheckboxProps);
-    muiTableHeadCellFilterTextFieldProps?: TextFieldProps | ((props: {
+    muiFilterTextFieldProps?: TextFieldProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
         rangeFilterIndex?: number;
     }) => TextFieldProps);
-    muiTableHeadCellFilterSliderProps?: SliderProps | ((props: {
+    muiFilterSliderProps?: SliderProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
     }) => TextFieldProps);
+    muiCreateRowModalProps?: DialogProps | ((props: {
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+    }) => DialogProps);
+    muiEditRowModalProps?: DialogProps | ((props: {
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+    }) => DialogProps);
     muiTableHeadCellProps?: TableCellProps | ((props: {
         table: MRT_TableInstance<TData>;
         column: MRT_Column<TData>;
@@ -641,6 +668,20 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
     muiTopToolbarProps?: ToolbarProps | ((props: {
         table: MRT_TableInstance<TData>;
     }) => ToolbarProps);
+    onCreatingRowCancel?: (props: {
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+    }) => void;
+    onCreatingRowChange?: OnChangeFn<MRT_Row<TData> | null>;
+    onCreatingRowSave?: (props: {
+        exitCreatingMode: () => void;
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+        values: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
+    }) => void;
+    onColumnFilterFnsChange?: OnChangeFn<{
+        [key: string]: MRT_FilterOption;
+    }>;
     onDensityChange?: OnChangeFn<MRT_DensityState>;
     onDraggingColumnChange?: OnChangeFn<MRT_Column<TData> | null>;
     onDraggingRowChange?: OnChangeFn<MRT_Row<TData> | null>;
@@ -649,19 +690,20 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => void;
+    onEditingRowChange?: OnChangeFn<MRT_Row<TData> | null>;
     onEditingRowSave?: (props: {
         exitEditingMode: () => void;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
         values: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
     }) => Promise<void> | void;
-    onEditingRowChange?: OnChangeFn<MRT_Row<TData> | null>;
-    onColumnFilterFnsChange?: OnChangeFn<{
-        [key: string]: MRT_FilterOption;
-    }>;
     onGlobalFilterFnChange?: OnChangeFn<MRT_FilterOption>;
-    onHoveredColumnChange?: OnChangeFn<MRT_Column<TData> | null>;
-    onHoveredRowChange?: OnChangeFn<MRT_Row<TData> | null>;
+    onHoveredColumnChange?: OnChangeFn<MRT_Column<TData> | {
+        id: string;
+    } | null>;
+    onHoveredRowChange?: OnChangeFn<MRT_Row<TData> | {
+        id: string;
+    } | null>;
     onIsFullScreenChange?: OnChangeFn<boolean>;
     onShowAlertBannerChange?: OnChangeFn<boolean>;
     onShowColumnFiltersChange?: OnChangeFn<boolean>;
@@ -679,6 +721,16 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
     renderBottomToolbarCustomActions?: (props: {
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
+    renderCreateRowModalContent?: (props: {
+        internalEditComponents: ReactNode[];
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+    }) => ReactNode;
+    renderEditRowModalContent?: (props: {
+        internalEditComponents: ReactNode[];
+        row: MRT_Row<TData>;
+        table: MRT_TableInstance<TData>;
+    }) => ReactNode;
     renderColumnActionsMenuItems?: (props: {
         column: MRT_Column<TData>;
         closeMenu: () => void;
@@ -724,34 +776,13 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> = Pr
     }) => ReactNode;
     rowCount?: number;
     rowNumberMode?: 'original' | 'static';
+    rowVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, HTMLTableRowElement> | null>;
+    rowVirtualizerOptions?: Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>> | ((props: {
+        table: MRT_TableInstance<TData>;
+    }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>);
     selectAllMode?: 'all' | 'page';
     /**
      * Manage state externally any way you want, then pass it back into MRT.
      */
     state?: Partial<MRT_TableState<TData>>;
-    /**
-     * Sequence of features important any dependent feature must be defined first
-     */
-    tableFeatures?: Array<MRT_CreateTableFeature<TData>>;
-    /**
-     * Get access to the table instance via a ref to read state or call built-in methods
-     */
-    tableInstanceRef?: MutableRefObject<MRT_TableInstance<TData> | null>;
-    /**
-     * @deprecated Use `rowVirtualizerInstanceRef` instead
-     */
-    virtualizerInstanceRef?: any;
-    /**
-     * @deprecated Use `rowVirtualizerProps` instead
-     */
-    virtualizerProps?: any;
-}> & {
-    columnVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, HTMLTableCellElement> | null>;
-    columnVirtualizerProps?: Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>> | ((props: {
-        table: MRT_TableInstance<TData>;
-    }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableCellElement>>);
-    rowVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, HTMLTableRowElement> | null>;
-    rowVirtualizerProps?: Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>> | ((props: {
-        table: MRT_TableInstance<TData>;
-    }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>);
 };

package/dist/esm/types/useMaterialReactTable.d.ts

@@ -0,0 +1,2 @@
+import { type MRT_TableInstance, type MRT_TableOptions } from './types';
+export declare const useMaterialReactTable: <TData extends Record<string, any>>(tableOptions: MRT_TableOptions<TData>) => MRT_TableInstance<TData>;