material-react-table 0.8.14 → 0.9.1

package/README.md

@@ -19,7 +19,7 @@
 
 View the [docs (alpha) site](https://www.material-react-table.com/)
 
-View a basic [example](https://codesandbox.io/s/github/KevinVandy/material-react-table/tree/main/material-react-table-docs/examples/basic/sandbox)
+View a basic [example](https://codesandbox.io/s/github/KevinVandy/material-react-table/tree/main/material-react-table-docs/examples/basic/sandbox?file=/src/TS.tsx)
 
 View additional [storybook examples](https://www.material-react-table.dev/)
 
@@ -72,3 +72,4 @@ npm install @mui/material @mui/icons-material @emotion/react @emotion/styled
 npm install material-react-table
 ```
 
+_`@tanstack/react-table` and `react-dnd`_ are internal dependencies, so you don't need to install them.

package/dist/MaterialReactTable.d.ts

@@ -21,21 +21,24 @@ export interface MRT_RowModel<D extends Record<string, any> = {}> {
 }
 export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit<TableInstance<Overwrite<Partial<TableGenerics>, {
     Row: D;
-}>>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
+}>>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getCenterLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getLeftLeafColumns' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRightLeafColumns' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
     getAllColumns: () => MRT_Column<D>[];
     getAllFlatColumns: () => MRT_Column<D>[];
     getAllLeafColumns: () => MRT_Column<D>[];
+    getCenterLeafColumns: () => MRT_Column<D>[];
     getColumn: (columnId: string) => MRT_Column<D>;
     getExpandedRowModel: () => MRT_RowModel<D>;
     getFlatHeaders: () => MRT_Header<D>[];
+    getLeftLeafColumns: () => MRT_Column<D>[];
     getPaginationRowModel: () => MRT_RowModel<D>;
     getPrePaginationRowModel: () => MRT_RowModel<D>;
+    getRightLeafColumns: () => MRT_Column<D>[];
     getRowModel: () => MRT_RowModel<D>;
     getSelectedRowModel: () => MRT_RowModel<D>;
     getState: () => MRT_TableState<D>;
     options: MaterialReactTableProps<D> & {
         icons: MRT_Icons;
-        idPrefix: string;
+        tableId: string;
         localization: MRT_Localization;
     };
     setCurrentEditingCell: Dispatch<SetStateAction<MRT_Cell | null>>;
@@ -63,6 +66,10 @@ export declare type MRT_TableState<D extends Record<string, any> = {}> = TableSt
     showSkeletons: boolean;
 };
 export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<ColumnDef<D>, 'accessorFN' | 'header' | 'footer' | 'columns' | 'filterFn'> & {
+    Cell?: ({ cell, tableInstance, }: {
+        cell: MRT_Cell<D>;
+        tableInstance: MRT_TableInstance<D>;
+    }) => ReactNode;
     Edit?: ({ cell, tableInstance, }: {
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
@@ -79,10 +86,6 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
         header: MRT_Header<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => ReactNode);
-    Cell?: ({ cell, tableInstance, }: {
-        cell: MRT_Cell<D>;
-        tableInstance: MRT_TableInstance<D>;
-    }) => ReactNode;
     accessorFN?: (row: D) => any;
     columns?: MRT_ColumnDef<D>[];
     enableClickToCopy?: boolean;
@@ -126,17 +129,17 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
         tableInstance: MRT_TableInstance;
         column: MRT_Column<D>;
     }) => TableCellProps);
-    onCellEditBlur?: ({ cell, event, tableInstance, }: {
+    onMrtCellEditBlur?: ({ cell, event, tableInstance, }: {
         event: FocusEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onCellEditChange?: ({ cell, event, tableInstance, }: {
+    onMrtCellEditChange?: ({ cell, event, tableInstance, }: {
         event: ChangeEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onColumnFilterValueChange?: ({ column, event, filterValue, }: {
+    onMrtFilterValueChange?: ({ column, event, filterValue, }: {
         column: MRT_Column<D>;
         event: ChangeEvent<HTMLInputElement>;
         filterValue: any;
@@ -189,7 +192,6 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     enabledColumnFilterOptions?: (MRT_FILTER_OPTION | string)[];
     enabledGlobalFilterOptions?: (MRT_FILTER_OPTION | string)[];
     icons?: Partial<MRT_Icons>;
-    idPrefix?: string;
     localization?: Partial<MRT_Localization>;
     muiLinearProgressProps?: LinearProgressProps | (({ tableInstance, }: {
         tableInstance: MRT_TableInstance;
@@ -262,12 +264,12 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
         tableInstance: MRT_TableInstance;
         headerGroup: MRT_HeaderGroup<D>;
     }) => TableRowProps);
-    muiTablePaperProps?: PaperProps | (({ tableInstance, }: {
-        tableInstance: MRT_TableInstance;
-    }) => PaperProps);
     muiTablePaginationProps?: Partial<TablePaginationProps> | (({ tableInstance, }: {
         tableInstance: MRT_TableInstance;
     }) => Partial<TablePaginationProps>);
+    muiTablePaperProps?: PaperProps | (({ tableInstance, }: {
+        tableInstance: MRT_TableInstance;
+    }) => PaperProps);
     muiTableProps?: TableProps | (({ tableInstance, }: {
         tableInstance: MRT_TableInstance;
     }) => TableProps);
@@ -280,81 +282,81 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     muiTableToolbarTopProps?: ToolbarProps | (({ tableInstance, }: {
         tableInstance: MRT_TableInstance;
     }) => ToolbarProps);
-    onCellClick?: ({ cell, event, tableInstance, }: {
+    onMrtCellClick?: ({ cell, event, tableInstance, }: {
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
         event: MouseEvent<HTMLTableCellElement>;
     }) => void;
-    onCellEditBlur?: ({ cell, event, tableInstance, }: {
+    onMrtCellEditBlur?: ({ cell, event, tableInstance, }: {
         event: FocusEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onCellEditChange?: ({ cell, event, tableInstance, }: {
+    onMrtCellEditChange?: ({ cell, event, tableInstance, }: {
         event: ChangeEvent<HTMLInputElement>;
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onColumnFilterValueChange?: ({ column, event, filterValue, }: {
-        column: MRT_Column<D>;
-        event: ChangeEvent<HTMLInputElement>;
-        filterValue: any;
-    }) => void;
-    onDetailPanelClick?: ({ event, row, tableInstance, }: {
+    onMrtDetailPanelClick?: ({ event, row, tableInstance, }: {
         event: MouseEvent<HTMLTableCellElement>;
         row: MRT_Row<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onGlobalSearchFilterChange?: ({ event, tableInstance, }: {
+    onMrtEditRowSubmit?: ({ row, tableInstance, }: {
+        row: MRT_Row<D>;
+        tableInstance: MRT_TableInstance<D>;
+    }) => Promise<void> | void;
+    onMrtFilterValueChange?: ({ column, event, filterValue, }: {
+        column: MRT_Column<D>;
+        event: ChangeEvent<HTMLInputElement>;
+        filterValue: any;
+    }) => void;
+    onMrtGlobalFilterValueChange?: ({ event, tableInstance, }: {
         event: ChangeEvent<HTMLInputElement>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onRowClick?: ({ event, row, tableInstance, }: {
+    onMrtRowClick?: ({ event, row, tableInstance, }: {
         event: MouseEvent<HTMLTableRowElement>;
         row: MRT_Row<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onEditSubmit?: ({ row, tableInstance, }: {
-        row: MRT_Row<D>;
-        tableInstance: MRT_TableInstance<D>;
-    }) => Promise<void> | void;
-    onRowExpandChange?: ({ event, row, }: {
+    onMrtRowExpandChange?: ({ event, row, }: {
         event: MouseEvent<HTMLButtonElement>;
         row: MRT_Row<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onSelectAllChange?: ({ event, selectedRows, tableInstance, }: {
+    onMrtSelectAllChange?: ({ event, selectedRows, tableInstance, }: {
         event: ChangeEvent;
         selectedRows: MRT_Row<D>[];
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onSelectChange?: ({ event, row, selectedRows, tableInstance, }: {
+    onMrtSelectRowChange?: ({ event, row, selectedRows, tableInstance, }: {
         event: ChangeEvent;
         row: MRT_Row<D>;
         selectedRows: MRT_Row<D>[];
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onToggleColumnVisibility?: ({ column, columnVisibility, tableInstance, }: {
+    onMrtToggleColumnVisibility?: ({ column, columnVisibility, tableInstance, }: {
         column: MRT_Column<D>;
         columnVisibility: VisibilityState;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onToggleDensePadding?: ({ event, isDensePadding, tableInstance, }: {
+    onMrtToggleDensePadding?: ({ event, isDensePadding, tableInstance, }: {
         event: MouseEvent<HTMLButtonElement>;
         isDensePadding: boolean;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onToggleFullScreen?: ({ event, isFullScreen, tableInstance, }: {
+    onMrtToggleFullScreen?: ({ event, isFullScreen, tableInstance, }: {
         event: MouseEvent<HTMLButtonElement>;
         isFullScreen: boolean;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onToggleShowFilters?: ({ event, showFilters, tableInstance, }: {
+    onMrtToggleShowFilters?: ({ event, showFilters, tableInstance, }: {
         event: MouseEvent<HTMLButtonElement>;
         showFilters: boolean;
         tableInstance: MRT_TableInstance<D>;
     }) => void;
-    onToggleShowGlobalFilter?: ({ event, showGlobalFilter, tableInstance, }: {
+    onMrtToggleShowGlobalFilter?: ({ event, showGlobalFilter, tableInstance, }: {
         event: MouseEvent<HTMLButtonElement>;
         showGlobalFilter: boolean;
         tableInstance: MRT_TableInstance<D>;
@@ -362,6 +364,7 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
     persistentStateMode?: 'localStorage' | 'sessionStorage';
     positionActionsColumn?: 'first' | 'last';
     positionPagination?: 'bottom' | 'top' | 'both';
+    positionGlobalFilter?: 'left' | 'right';
     positionToolbarActions?: 'bottom' | 'top';
     positionToolbarAlertBanner?: 'bottom' | 'top';
     renderDetailPanel?: ({ row, tableInstance, }: {
@@ -399,6 +402,7 @@ export declare type MaterialReactTableProps<D extends Record<string, any> = {}>
         }>;
     }) => ReactNode;
     selectAllMode?: 'all' | 'page';
+    tableId?: string;
 };
-declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensePaddingToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGrouping, enableHiding, enableMultiRowSelection, enablePagination, enablePinning, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, persistentStateMode, positionActionsColumn, positionPagination, positionToolbarActions, positionToolbarAlertBanner, selectAllMode, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
+declare const _default: <D extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensePaddingToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGrouping, enableHiding, enableMultiRowSelection, enablePagination, enablePinning, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, persistentStateMode, positionActionsColumn, positionPagination, positionGlobalFilter, positionToolbarActions, positionToolbarAlertBanner, selectAllMode, ...rest }: MaterialReactTableProps<D>) => JSX.Element;
 export default _default;