material-react-table 0.7.6 → 0.8.0

package/README.md

@@ -2,7 +2,7 @@
 
 > This Project is based on react-table v8, which itself is still in alpha, and therefore this package is also still in alpha
 
-- A fully featured Material UI v5 implementation of react-table v8 (alpha)
+- A fully featured Material UI v5 implementation of Tanstack react-table v8 (alpha)
 - Inspired by material-table and the MUI X DataGrid
 - Written from the ground up in TypeScript, Material UI, and React Table
 - All internal Material UI components are easily customizable

package/dist/MaterialReactTable.d.ts

@@ -1,10 +1,10 @@
 import { ChangeEvent, Dispatch, FC, FocusEvent, MouseEvent, ReactNode, SetStateAction } from 'react';
 import { AlertProps, ButtonProps, CheckboxProps, IconButtonProps, LinearProgressProps, PaperProps, SkeletonProps, TableBodyProps, TableCellProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, TableProps, TableRowProps, TextFieldProps, ToolbarProps } from '@mui/material';
-import { Cell, Column, ColumnDef, DefaultGenerics, FilterFn, FilterFnOption, Header, HeaderGroup, Options, Overwrite, PaginationState, Row, TableInstance, TableState, VisibilityState } from '@tanstack/react-table';
+import { Cell, Column, ColumnDef, FilterFn, FilterFnOption, Header, HeaderGroup, Overwrite, PaginationState, ReactTableGenerics, Row, TableGenerics, TableInstance, TableState, UseTableInstanceOptions, VisibilityState } from '@tanstack/react-table';
 import { MRT_Localization } from './localization';
 import { MRT_Icons } from './icons';
 import { MRT_FILTER_OPTION } from './enums';
-export declare type MRT_TableOptions<D extends Record<string, any> = {}> = Partial<Omit<Options<D>, 'columns' | 'data' | 'initialState' | 'state' | 'expandRowsFn' | 'filterFns'>> & {
+export declare type MRT_TableOptions<D extends Record<string, any> = {}> = Partial<Omit<UseTableInstanceOptions<ReactTableGenerics>, 'columns' | 'data' | 'initialState' | 'state' | 'expandRowsFn' | 'filterFns'>> & {
     columns: MRT_ColumnDef<D>[];
     data: D[];
     expandRowsFn?: (dataRow: D) => D[];
@@ -19,11 +19,12 @@ export interface MRT_RowModel<D extends Record<string, any> = {}> {
         [key: string]: MRT_Row<D>;
     };
 }
-export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit<TableInstance<Overwrite<Partial<DefaultGenerics>, {
+export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit<TableInstance<Overwrite<Partial<TableGenerics>, {
     Row: D;
-}>>, 'getAllColumns' | 'getAllLeafColumns' | 'getExpandedRowModel' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
+}>>, 'getAllColumns' | 'getAllLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
     getAllColumns: () => MRT_Column<D>[];
     getAllLeafColumns: () => MRT_Column<D>[];
+    getColumn: (columnId: string) => MRT_Column<D>;
     getExpandedRowModel: () => MRT_RowModel<D>;
     getPaginationRowModel: () => MRT_RowModel<D>;
     getPrePaginationRowModel: () => MRT_RowModel<D>;
@@ -35,10 +36,10 @@ export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit
         idPrefix: string;
         localization: MRT_Localization;
     };
-    setCurrentEditingCell: Dispatch<SetStateAction<MRT_Cell<D> | null>>;
-    setCurrentEditingRow: Dispatch<SetStateAction<MRT_Row<D> | null>>;
+    setCurrentEditingCell: Dispatch<SetStateAction<MRT_Cell | null>>;
+    setCurrentEditingRow: Dispatch<SetStateAction<MRT_Row | null>>;
     setCurrentFilterFns: Dispatch<SetStateAction<{
-        [key: string]: MRT_FilterFn<D>;
+        [key: string]: MRT_FilterFn;
     }>>;
     setCurrentGlobalFilterFn: Dispatch<SetStateAction<MRT_FilterFn<D>>>;
     setIsDensePadding: Dispatch<SetStateAction<boolean>>;
@@ -52,10 +53,13 @@ export declare type MRT_TableState<D extends Record<string, any> = {}> = Omit<Ta
     currentFilterFns: Record<string, string | Function>;
     currentGlobalFilterFn: Record<string, string | Function>;
     isDensePadding: boolean;
+    isLoading: boolean;
     isFullScreen: boolean;
+    pagination: Partial<PaginationState>;
     showFilters: boolean;
     showGlobalFilter: boolean;
-    pagination: Partial<PaginationState>;
+    showProgressBars: boolean;
+    showSkeletons: boolean;
 };
 export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<ColumnDef<D>, 'header' | 'footer' | 'columns' | 'filterFn'> & {
     Edit?: ({ cell, tableInstance, }: {
@@ -137,6 +141,9 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
 };
 export declare type MRT_Column<D extends Record<string, any> = {}> = Omit<Column<D>, 'header' | 'footer' | 'columns'> & MRT_ColumnDef<D> & {
     columns?: MRT_Column<D>[];
+    columnDef: MRT_ColumnDef<D>;
+    header: string;
+    footer: string;
 };
 export declare type MRT_Header<D extends Record<string, any> = {}> = Omit<Header<D>, 'column'> & {
     column: MRT_Column<D>;
@@ -144,11 +151,8 @@ export declare type MRT_Header<D extends Record<string, any> = {}> = Omit<Header
 export declare type MRT_HeaderGroup<D extends Record<string, any> = {}> = Omit<HeaderGroup<D>, 'headers'> & {
     headers: MRT_Header<D>[];
 };
-export declare type MRT_Row<D extends Record<string, any> = {}> = Omit<Row<D>, 'getVisibleCells' | 'getAllCells' | 'subRows' | 'original' | 'getLeftVisibleCells' | 'getRightVisibleCells' | 'getCenterVisibleCells'> & {
+export declare type MRT_Row<D extends Record<string, any> = {}> = Omit<Row<D>, 'getVisibleCells' | 'getAllCells' | 'subRows' | 'original'> & {
     getAllCells: () => MRT_Cell<D>[];
-    getCenterVisibleCells: () => MRT_Cell<D>[];
-    getLeftVisibleCells: () => MRT_Cell<D>[];
-    getRightVisibleCells: () => MRT_Cell<D>[];
     getVisibleCells: () => MRT_Cell<D>[];
     subRows?: MRT_Row<D>[];
     original: D;
@@ -157,7 +161,7 @@ export declare type MRT_Cell<D extends Record<string, any> = {}> = Omit<Cell<D>,
     column: MRT_Column<D>;
     row: MRT_Row<D>;
 };
-export declare type MRT_FilterFn<D extends Record<string, any> = {}> = FilterFn<D> | FilterFnOption<D> | MRT_FILTER_OPTION | number | string | symbol;
+export declare type MRT_FilterFn<D extends Record<string, any> = {}> = FilterFn<TableGenerics> | FilterFnOption<D> | MRT_FILTER_OPTION | number | string | symbol;
 export declare type MaterialReactTableProps<D extends Record<string, any> = {}> = MRT_TableOptions<D> & {
     editingMode?: 'table' | 'row' | 'cell';
     enableClickToCopy?: boolean;
@@ -181,8 +185,6 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     enabledGlobalFilterOptions?: (MRT_FILTER_OPTION | string)[];
     icons?: Partial<MRT_Icons>;
     idPrefix?: string;
-    isLoading?: boolean;
-    isReloading?: boolean;
     localization?: Partial<MRT_Localization>;
     muiLinearProgressProps?: LinearProgressProps | (({ tableInstance, }: {
         tableInstance: MRT_TableInstance;
@@ -392,5 +394,5 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
         }>;
     }) => ReactNode;
 };
-declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, autoResetSorting, columnResizeMode, editingMode, enableColumnActions, enableColumnFilters, enableColumnResizing, enableDensePaddingToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableHiding, enableMultiRowSelection, enablePagination, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, persistentStateMode, positionActionsColumn, positionPagination, positionToolbarActions, positionToolbarAlertBanner, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
+declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilters, enableColumnResizing, enableDensePaddingToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableHiding, enableMultiRowSelection, enablePagination, enablePinning, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, persistentStateMode, positionActionsColumn, positionPagination, positionToolbarActions, positionToolbarAlertBanner, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
 export default _default;

package/dist/body/MRT_TableBody.d.ts

@@ -1,7 +1,6 @@
 import { FC } from 'react';
 import { MRT_TableInstance } from '..';
 interface Props {
-    pinned: 'left' | 'center' | 'right' | 'none';
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_TableBody: FC<Props>;

package/dist/body/MRT_TableBodyCell.d.ts

@@ -2,6 +2,7 @@ import { FC } from 'react';
 import type { MRT_Cell, MRT_TableInstance } from '..';
 interface Props {
     cell: MRT_Cell;
+    enableHover?: boolean;
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_TableBodyCell: FC<Props>;

package/dist/body/MRT_TableBodyRow.d.ts

@@ -1,7 +1,6 @@
 import { FC } from 'react';
 import type { MRT_Row, MRT_TableInstance } from '..';
 interface Props {
-    pinned: 'left' | 'center' | 'right' | 'none';
     row: MRT_Row;
     tableInstance: MRT_TableInstance;
 }

package/dist/buttons/MRT_CopyButton.d.ts

@@ -1,7 +1,8 @@
-import { FC } from 'react';
+import { FC, ReactNode } from 'react';
 import { MRT_Cell, MRT_TableInstance } from '..';
 interface Props {
     cell: MRT_Cell;
+    children: ReactNode;
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_CopyButton: FC<Props>;

package/dist/enums.d.ts

@@ -1,10 +1,10 @@
 export declare enum MRT_FILTER_OPTION {
-    BEST_MATCH = "bestMatch",
-    BEST_MATCH_FIRST = "bestMatchFirst",
+    BETWEEN = "between",
     CONTAINS = "contains",
     EMPTY = "empty",
     ENDS_WITH = "endsWith",
     EQUALS = "equals",
+    FUZZY = "fuzzy",
     GREATER_THAN = "greaterThan",
     LESS_THAN = "lessThan",
     NOT_EMPTY = "notEmpty",

package/dist/filtersFNs.d.ts

@@ -1,91 +1,92 @@
+import { RankingInfo } from '@tanstack/match-sorter-utils';
 import { MRT_Row } from '.';
-export declare const bestMatchFirst: {
-    (rows: MRT_Row[], columnIds: string[] | string, filterValue: string | number): MRT_Row<{}>[];
-    autoRemove(val: any): boolean;
-};
-export declare const bestMatch: {
-    (rows: MRT_Row[], columnIds: string[] | string, filterValue: string | number): MRT_Row<{}>[];
+export declare const fuzzy: {
+    (row: MRT_Row, columnId: string, value: string, addMeta: (item: RankingInfo) => void): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const contains: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): any;
     autoRemove(val: any): boolean;
 };
 export declare const startsWith: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): any;
     autoRemove(val: any): boolean;
 };
 export declare const endsWith: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): any;
     autoRemove(val: any): boolean;
 };
 export declare const equals: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const notEquals: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const greaterThan: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const lessThan: {
-    (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, filterValue: string | number): boolean;
+    autoRemove(val: any): boolean;
+};
+export declare const between: {
+    (row: MRT_Row, id: string, filterValues: [string | number, string | number]): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const empty: {
-    (rows: MRT_Row[], id: string, _filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, _filterValue: string | number): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const notEmpty: {
-    (rows: MRT_Row[], id: string, _filterValue: string | number): MRT_Row<{}>[];
+    (row: MRT_Row, id: string, _filterValue: string | number): boolean;
     autoRemove(val: any): boolean;
 };
 export declare const defaultFilterFNs: {
-    bestMatch: {
-        (rows: MRT_Row[], columnIds: string[] | string, filterValue: string | number): MRT_Row<{}>[];
-        autoRemove(val: any): boolean;
-    };
-    bestMatchFirst: {
-        (rows: MRT_Row[], columnIds: string[] | string, filterValue: string | number): MRT_Row<{}>[];
+    between: {
+        (row: MRT_Row, id: string, filterValues: [string | number, string | number]): boolean;
         autoRemove(val: any): boolean;
     };
     contains: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): any;
         autoRemove(val: any): boolean;
     };
     empty: {
-        (rows: MRT_Row[], id: string, _filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, _filterValue: string | number): boolean;
         autoRemove(val: any): boolean;
     };
     endsWith: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): any;
         autoRemove(val: any): boolean;
     };
     equals: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): boolean;
+        autoRemove(val: any): boolean;
+    };
+    fuzzy: {
+        (row: MRT_Row, columnId: string, value: string, addMeta: (item: RankingInfo) => void): boolean;
         autoRemove(val: any): boolean;
     };
     greaterThan: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): boolean;
         autoRemove(val: any): boolean;
     };
     lessThan: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): boolean;
         autoRemove(val: any): boolean;
     };
     notEmpty: {
-        (rows: MRT_Row[], id: string, _filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, _filterValue: string | number): boolean;
         autoRemove(val: any): boolean;
     };
     notEquals: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): boolean;
         autoRemove(val: any): boolean;
     };
     startsWith: {
-        (rows: MRT_Row[], id: string, filterValue: string | number): MRT_Row<{}>[];
+        (row: MRT_Row, id: string, filterValue: string | number): any;
         autoRemove(val: any): boolean;
     };
 };

package/dist/footer/MRT_TableFooter.d.ts

@@ -1,7 +1,6 @@
 import { FC } from 'react';
 import type { MRT_TableInstance } from '..';
 interface Props {
-    pinned: 'left' | 'center' | 'right' | 'none';
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_TableFooter: FC<Props>;

package/dist/head/MRT_TableHead.d.ts

@@ -1,7 +1,6 @@
 import { FC } from 'react';
 import type { MRT_TableInstance } from '..';
 interface Props {
-    pinned: 'left' | 'center' | 'right' | 'none';
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_TableHead: FC<Props>;

package/dist/inputs/MRT_FilterRangeFields.d.ts

@@ -0,0 +1,8 @@
+import { FC } from 'react';
+import { MRT_Header, MRT_TableInstance } from '..';
+interface Props {
+    header: MRT_Header;
+    tableInstance: MRT_TableInstance;
+}
+declare const MRT_FilterRangeFields: FC<Props>;
+export default MRT_FilterRangeFields;

package/dist/inputs/MRT_FilterTextField.d.ts

@@ -2,6 +2,7 @@ import { FC } from 'react';
 import type { MRT_Header, MRT_TableInstance } from '..';
 interface Props {
     header: MRT_Header;
+    inputIndex?: number;
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_FilterTextField: FC<Props>;

package/dist/localization.d.ts

@@ -1,5 +1,6 @@
 export interface MRT_Localization {
     actions: string;
+    and: string;
     cancel: string;
     changeFilterMode: string;
     changeSearchMode: string;
@@ -12,13 +13,13 @@ export interface MRT_Localization {
     edit: string;
     expand: string;
     expandAll: string;
-    filterBestMatch: string;
-    filterBestMatchFirst: string;
+    filterBetween: string;
     filterByColumn: string;
     filterContains: string;
     filterEmpty: string;
     filterEndsWith: string;
     filterEquals: string;
+    filterFuzzy: string;
     filterGreaterThan: string;
     filterLessThan: string;
     filterMode: string;
@@ -30,6 +31,8 @@ export interface MRT_Localization {
     groupedBy: string;
     hideAll: string;
     hideColumn: string;
+    max: string;
+    min: string;
     pinToLeft: string;
     pinToRight: string;
     resetColumnSize: string;
@@ -50,6 +53,7 @@ export interface MRT_Localization {
     sortedByColumnAsc: string;
     sortedByColumnDesc: string;
     thenBy: string;
+    to: string;
     toggleDensePadding: string;
     toggleFullScreen: string;
     toggleSelectAll: string;