material-react-table 0.8.9 → 0.8.12

package/README.md

@@ -1,46 +1,60 @@
 # Material React Table
 
-> This Project is based on react-table v8, which itself is still in alpha, and therefore this package is also still in alpha
+<a href="https://bundlephobia.com/result?p=material-react-table" target="\_parent">
+  <img alt="" src="https://badgen.net/bundlephobia/minzip/material-react-table" />
+</a>
 
-- A fully featured Material UI v5 implementation of Tanstack react-table v8 (alpha)
+<a href="https://npmjs.com/package/material-react-table" target="\_parent">
+  <img alt="" src="https://img.shields.io/npm/dm/material-react-table.svg" />
+</a>
+
+> This Project is based on `@tanstack/react-table` v8, which itself is still in beta, so therefore this package is also still in alpha/beta
+
+- A fully featured Material UI V5 implementation of Tanstack React Table v8 (beta)
 - 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
 
-## This project is in alpha, but feel free to install and explore
+## This project is in alpha, but will go into beta _soon<sup>TM</sup>_, so feel free to install and explore
 
 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 additional [storybook examples](https://www.material-react-table.dev/)
 
 View the [github source code](https://github.com/KevinVandy/material-react-table) and [github open issues](https://github.com/KevinVandy/material-react-table/issues)
 
 Join the [discord](https://discord.gg/5wqyRx6fnm) server to join in on the development discussion or ask questions
 
-### Features (Some Still In Active Development)
+### Features (Some still being polished, but all are functional!)
 
 - [x] Click To Copy Cell Values
 - [x] Column Actions
-- [x] Column Hiding
 - [x] Column Grouping (Group By and Aggregates)
-- [x] Column Ordering (react-dnd)
+- [x] Column Hiding
+- [x] Column Ordering via Drag'n'Drop (react-dnd)
 - [x] Column Pinning
 - [x] Column Resizing (work in progress)
-- [x] Custom Icons
-- [x] Custom Styling and internal Mui Components
-- [x] Data Editing
+- [x] Customize Icons
+- [x] Customize Styling of internal Mui Components
+- [x] Data Editing (3 different editing modes)
 - [x] Dense Padding Toggle
+- [x] Detail Panels
 - [x] Filtering and multiple built-in filter modes
-- [x] Fullscreen
-- [x] Global Filtering (Search)
-- [x] HeaderGroups
-- [x] Localization i18n
+- [x] Fullscreen mode
+- [x] Global Filtering (Search across all columns, rank by best match)
+- [x] HeaderGroups & Footers
+- [x] Localization (i18n) support
+- [x] Manage your own state
 - [x] Pagination (supports client-side and server-side)
+- [x] Persistent State
 - [x] Row Actions
-- [x] Row Selection
+- [x] Row Selection (checkboxes)
 - [x] SSR compatible
 - [x] Sorting
-- [x] Toolbars
+- [x] Theming (Respects your Material UI Theme)
+- [x] Toolbars (Add your own action buttons)
 - [x] Tree Data / Expanding Subrows
 - [ ] Virtualization (planned)
 

package/dist/MaterialReactTable.d.ts

@@ -1,6 +1,6 @@
 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, FilterFn, FilterFnOption, Header, HeaderGroup, Overwrite, PaginationState, ReactTableGenerics, Row, TableGenerics, TableInstance, TableState, UseTableInstanceOptions, VisibilityState } from '@tanstack/react-table';
+import { Cell, Column, ColumnDef, FilterFn, FilterFnOption, Header, HeaderGroup, Overwrite, 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';
@@ -21,11 +21,13 @@ 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' | 'getAllLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
+}>>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getPaginationRowModel' | 'getPrePaginationRowModel' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'options'> & {
     getAllColumns: () => MRT_Column<D>[];
+    getAllFlatColumns: () => MRT_Column<D>[];
     getAllLeafColumns: () => MRT_Column<D>[];
     getColumn: (columnId: string) => MRT_Column<D>;
     getExpandedRowModel: () => MRT_RowModel<D>;
+    getFlatHeaders: () => MRT_Header<D>[];
     getPaginationRowModel: () => MRT_RowModel<D>;
     getPrePaginationRowModel: () => MRT_RowModel<D>;
     getRowModel: () => MRT_RowModel<D>;
@@ -47,7 +49,7 @@ export declare type MRT_TableInstance<D extends Record<string, any> = {}> = Omit
     setShowFilters: Dispatch<SetStateAction<boolean>>;
     setShowGlobalFilter: Dispatch<SetStateAction<boolean>>;
 };
-export declare type MRT_TableState<D extends Record<string, any> = {}> = Omit<TableState, 'pagination'> & {
+export declare type MRT_TableState<D extends Record<string, any> = {}> = TableState & {
     currentEditingCell: MRT_Cell<D> | null;
     currentEditingRow: MRT_Row<D> | null;
     currentFilterFns: Record<string, string | Function>;
@@ -55,13 +57,12 @@ export declare type MRT_TableState<D extends Record<string, any> = {}> = Omit<Ta
     isDensePadding: boolean;
     isLoading: boolean;
     isFullScreen: boolean;
-    pagination: Partial<PaginationState>;
     showFilters: boolean;
     showGlobalFilter: boolean;
     showProgressBars: boolean;
     showSkeletons: boolean;
 };
-export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<ColumnDef<D>, 'header' | 'footer' | 'columns' | 'filterFn'> & {
+export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<ColumnDef<D>, 'accessorFN' | 'header' | 'footer' | 'columns' | 'filterFn'> & {
     Edit?: ({ cell, tableInstance, }: {
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
@@ -70,19 +71,19 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
         header: MRT_Header<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => ReactNode;
-    Footer?: ({ footer, tableInstance, }: {
+    Footer?: ReactNode | (({ footer, tableInstance, }: {
         footer: MRT_Header<D>;
         tableInstance: MRT_TableInstance<D>;
-    }) => ReactNode;
-    Header?: ({ header, tableInstance, }: {
+    }) => ReactNode);
+    Header?: ReactNode | (({ header, tableInstance, }: {
         header: MRT_Header<D>;
         tableInstance: MRT_TableInstance<D>;
-    }) => ReactNode;
+    }) => ReactNode);
     Cell?: ({ cell, tableInstance, }: {
         cell: MRT_Cell<D>;
         tableInstance: MRT_TableInstance<D>;
     }) => ReactNode;
-    id: keyof D | string;
+    accessorFN?: (row: D) => any;
     columns?: MRT_ColumnDef<D>[];
     enableClickToCopy?: boolean;
     enableColumnActions?: boolean;
@@ -96,6 +97,7 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
     })[];
     footer?: string;
     header: string;
+    id: keyof D | string;
     muiTableBodyCellCopyButtonProps?: ButtonProps | (({ tableInstance, cell, }: {
         tableInstance: MRT_TableInstance;
         cell: MRT_Cell<D>;
@@ -140,7 +142,7 @@ export declare type MRT_ColumnDef<D extends Record<string, any> = {}> = Omit<Col
         filterValue: any;
     }) => void;
 };
-export declare type MRT_Column<D extends Record<string, any> = {}> = Omit<Column<D>, 'header' | 'footer' | 'columns'> & MRT_ColumnDef<D> & {
+export declare type MRT_Column<D extends Record<string, any> = {}> = Omit<Column<D>, 'header' | 'footer' | 'columns'> & {
     columns?: MRT_Column<D>[];
     columnDef: MRT_ColumnDef<D>;
     header: string;
@@ -152,11 +154,12 @@ 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'> & {
+export declare type MRT_Row<D extends Record<string, any> = {}> = Omit<Row<D>, 'getVisibleCells' | 'getAllCells' | 'subRows' | 'original' | '_valuesCache'> & {
     getAllCells: () => MRT_Cell<D>[];
     getVisibleCells: () => MRT_Cell<D>[];
     subRows?: MRT_Row<D>[];
     original: D;
+    _valuesCache?: D;
 };
 export declare type MRT_Cell<D extends Record<string, any> = {}> = Omit<Cell<D>, 'column' | 'row'> & {
     column: MRT_Column<D>;

package/dist/localization.d.ts

@@ -37,6 +37,7 @@ export interface MRT_Localization {
     pinToLeft: string;
     pinToRight: string;
     resetColumnSize: string;
+    resetOrder: string;
     rowActions: string;
     rowNumber: string;
     rowNumbers: string;