material-react-table 0.16.2 → 0.18.0

package/README.md

@@ -59,7 +59,7 @@ _All features can easily be enabled/disabled_
 - [x] Localization (i18n) support
 - [x] Manage your own state
 - [x] Pagination (supports client-side and server-side)
-- [x] Persistent State
+- [x] Remote/Server-side sorting and filtering supported
 - [x] Row Actions
 - [x] Row Numbers
 - [x] Row Selection (checkboxes)

package/dist/MaterialReactTable.d.ts

@@ -1,6 +1,6 @@
-import { ChangeEvent, Dispatch, FC, FocusEvent, MouseEvent, ReactNode, SetStateAction } from 'react';
+import { ChangeEvent, Dispatch, FC, FocusEvent, 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, ColumnOrderState, ColumnPinningState, FilterFn, FilterFnOption, Header, HeaderGroup, OnChangeFn, Overwrite, ReactTableGenerics, Row, SortingFn, SortingFnOption, TableGenerics, TableInstance, TableState, UseTableInstanceOptions, VisibilityState } from '@tanstack/react-table';
+import { Cell, Column, ColumnDef, FilterFn, FilterFnOption, Header, HeaderGroup, OnChangeFn, Overwrite, ReactTableGenerics, Row, SortingFn, SortingFnOption, TableGenerics, TableInstance, TableState, UseTableInstanceOptions } from '@tanstack/react-table';
 import { Options as VirtualizerOptions } from 'react-virtual';
 import { MRT_Localization } from './localization';
 import { MRT_Icons } from './icons';
@@ -49,6 +49,7 @@ export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit
     setCurrentGlobalFilterFn: Dispatch<SetStateAction<MRT_FilterFn>>;
     setDensity: Dispatch<SetStateAction<'comfortable' | 'compact' | 'spacious'>>;
     setIsFullScreen: Dispatch<SetStateAction<boolean>>;
+    setShowAlertBanner: Dispatch<SetStateAction<boolean>>;
     setShowFilters: Dispatch<SetStateAction<boolean>>;
     setShowGlobalFilter: Dispatch<SetStateAction<boolean>>;
 };
@@ -60,6 +61,7 @@ export declare type MRT_TableState<D extends Record<string, any> = {}> = TableSt
     density: 'comfortable' | 'compact' | 'spacious';
     isLoading: boolean;
     isFullScreen: boolean;
+    showAlertBanner: boolean;
     showFilters: boolean;
     showGlobalFilter: boolean;
     showProgressBars: boolean;
@@ -139,23 +141,11 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
         cell: MRT_Cell<D>;
         instance: MRT_TableInstance<D>;
     }) => void;
-    onCellEditChanged?: ({ cell, event, instance, }: {
+    onCellEditChange?: ({ cell, event, instance, }: {
         event: ChangeEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         instance: MRT_TableInstance<D>;
     }) => void;
-    onColumnFilterValueChanged?: ({ column, event, filterValue, instance, }: {
-        column: MRT_Column<D>;
-        event: ChangeEvent<HTMLInputElement>;
-        filterValue: any;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onColumnFilterValueChangedDebounced?: ({ column, event, filterValue, instance, }: {
-        column: MRT_Column<D>;
-        event: ChangeEvent<HTMLInputElement>;
-        filterValue: any;
-        instance: MRT_TableInstance<D>;
-    }) => void;
     sortingFn?: MRT_SortingFn;
 };
 export declare type MRT_Column<D extends Record<string, any> = {}> = Omit<Column<D>, 'header' | 'footer' | 'columns' | 'columnDef'> & {
@@ -198,7 +188,6 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     enableGlobalFilterChangeMode?: boolean;
     enableGlobalFilterRankedResults?: boolean;
     enablePagination?: boolean;
-    enablePersistentState?: boolean;
     enableRowActions?: boolean;
     enableRowNumbers?: boolean;
     enableRowVirtualization?: boolean;
@@ -311,115 +300,31 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     muiTableToolbarTopProps?: ToolbarProps | (({ instance }: {
         instance: MRT_TableInstance<D>;
     }) => ToolbarProps);
-    onCellClick?: ({ cell, event, instance, }: {
-        cell: MRT_Cell<D>;
-        instance: MRT_TableInstance<D>;
-        event: MouseEvent<HTMLTableCellElement>;
-    }) => void;
     onCellEditBlur?: ({ cell, event, instance, }: {
         event: FocusEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         instance: MRT_TableInstance<D>;
     }) => void;
-    onCellEditChanged?: ({ cell, event, instance, }: {
+    onCellEditChange?: ({ cell, event, instance, }: {
         event: ChangeEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         instance: MRT_TableInstance<D>;
     }) => void;
-    onColumnFilterValueChanged?: ({ column, event, filterValue, instance, }: {
-        column: MRT_Column<D>;
-        event: ChangeEvent<HTMLInputElement>;
-        filterValue: any;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onColumnFilterValueChangedDebounced?: ({ column, event, filterValue, instance, }: {
-        column: MRT_Column<D>;
-        event: ChangeEvent<HTMLInputElement>;
-        filterValue: any;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onColumnOrderChanged?: ({ columnOrder, instance, }: {
-        columnOrder: ColumnOrderState;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onColumnPinningChanged?: ({ columnPinning, instance, }: {
-        columnPinning: ColumnPinningState;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onColumnVisibilityChanged?: ({ column, columnVisibility, instance, }: {
-        column: MRT_Column<D>;
-        columnVisibility: VisibilityState;
-        instance: MRT_TableInstance<D>;
-    }) => void;
     onCurrentEditingCellChange?: OnChangeFn<MRT_Cell>;
     onCurrentEditingRowChange?: OnChangeFn<MRT_Row>;
     onCurrentFilterFnsChange?: OnChangeFn<{
         [key: string]: MRT_FilterFn;
     }>;
     onCurrentGlobalFilterFnChange?: OnChangeFn<MRT_FilterFn>;
-    onDetailPanelClick?: ({ event, row, instance, }: {
-        event: MouseEvent<HTMLTableCellElement>;
-        row: MRT_Row<D>;
-        instance: MRT_TableInstance<D>;
-    }) => void;
     onEditRowSubmit?: ({ row, instance, }: {
         row: MRT_Row<D>;
         instance: MRT_TableInstance<D>;
     }) => Promise<void> | void;
-    onExpandChanged?: ({ event, row, }: {
-        event: MouseEvent<HTMLButtonElement>;
-        row: MRT_Row<D>;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onGlobalFilterValueChanged?: ({ event, instance, }: {
-        event: ChangeEvent<HTMLInputElement>;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onGlobalFilterValueChangedDebounced?: ({ event, instance, }: {
-        event: ChangeEvent<HTMLInputElement>;
-        instance: MRT_TableInstance<D>;
-    }) => void;
     onDensityChange?: OnChangeFn<boolean>;
-    onDensityChanged?: ({ event, density, instance, }: {
-        event: MouseEvent<HTMLButtonElement>;
-        density: 'comfortable' | 'compact' | 'spacious';
-        instance: MRT_TableInstance<D>;
-    }) => void;
     onIsFullScreenChange?: OnChangeFn<boolean>;
-    onIsFullScreenChanged?: ({ event, isFullScreen, instance, }: {
-        event: MouseEvent<HTMLButtonElement>;
-        isFullScreen: boolean;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onRowClick?: ({ event, row, instance, }: {
-        event: MouseEvent<HTMLTableRowElement>;
-        row: MRT_Row<D>;
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onRowSelectAllChanged?: ({ event, selectedRows, instance, }: {
-        event: ChangeEvent;
-        selectedRows: MRT_Row<D>[];
-        instance: MRT_TableInstance<D>;
-    }) => void;
-    onRowSelectionChanged?: ({ event, row, selectedRows, instance, }: {
-        event: ChangeEvent;
-        row: MRT_Row<D>;
-        selectedRows: MRT_Row<D>[];
-        instance: MRT_TableInstance<D>;
-    }) => void;
+    onShowAlertBannerChange?: OnChangeFn<boolean>;
     onShowFiltersChange?: OnChangeFn<boolean>;
-    onShowFiltersChanged?: ({ event, instance, showFilters, }: {
-        event: MouseEvent<HTMLButtonElement>;
-        instance: MRT_TableInstance<D>;
-        showFilters: boolean;
-    }) => void;
     onShowGlobalFilterChange?: OnChangeFn<boolean>;
-    onShowGlobalFilterChanged?: ({ event, instance, showGlobalFilter, }: {
-        event: MouseEvent<HTMLButtonElement>;
-        instance: MRT_TableInstance<D>;
-        showGlobalFilter: boolean;
-    }) => void;
-    persistentStateMode?: 'localStorage' | 'sessionStorage';
     positionActionsColumn?: 'first' | 'last';
     positionGlobalFilter?: 'left' | 'right';
     positionPagination?: 'bottom' | 'top' | 'both';
@@ -461,10 +366,11 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
             instance: MRT_TableInstance<D>;
         }>;
     }) => ReactNode;
+    rowCount?: number;
     rowNumberMode?: 'original' | 'static';
     selectAllMode?: 'all' | 'page';
     tableId?: string;
     virtualizerProps?: Partial<VirtualizerOptions<HTMLDivElement>>;
 };
-declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilterChangeMode, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGlobalFilterChangeMode, enableGlobalFilterRankedResults, enableGrouping, enableHiding, enableMultiRowSelection, enableMultiSort, enablePagination, enablePinning, enableRowSelection, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, persistentStateMode, positionActionsColumn, positionGlobalFilter, positionPagination, positionToolbarAlertBanner, rowNumberMode, selectAllMode, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
+declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilterChangeMode, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGlobalFilterChangeMode, enableGlobalFilterRankedResults, enableGrouping, enableHiding, enableMultiRowSelection, enableMultiSort, enablePagination, enablePinning, enableRowSelection, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, positionActionsColumn, positionGlobalFilter, positionPagination, positionToolbarAlertBanner, rowNumberMode, selectAllMode, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
 export default _default;