material-react-table 2.0.0-beta.1 → 2.0.0-beta.3

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

@@ -1,5 +1,5 @@
 import { type Dispatch, type MutableRefObject, type ReactNode, type RefObject, type SetStateAction } from 'react';
-import { type AggregationFn, type Cell, type Column, type ColumnDef, type ColumnFiltersState, type ColumnOrderState, type ColumnPinningState, type ColumnSizingInfoState, type ColumnSizingState, type DeepKeys, type ExpandedState, type FilterFn, type GroupingState, type Header, type HeaderGroup, type OnChangeFn, type PaginationState, type Row, type RowSelectionState, type SortingFn, type SortingState, type Table, type TableOptions, type TableState, type Updater, type VisibilityState } from '@tanstack/react-table';
+import { type AccessorFn, type AggregationFn, type Cell, type Column, type ColumnDef, type ColumnFiltersState, type ColumnOrderState, type ColumnPinningState, type ColumnSizingInfoState, type ColumnSizingState, type DeepKeys, type DeepValue, type ExpandedState, type FilterFn, type GroupingState, type Header, type HeaderGroup, type OnChangeFn, type PaginationState, type Row, type RowSelectionState, type SortingFn, type SortingState, type Table, type TableOptions, type TableState, type Updater, type VisibilityState } from '@tanstack/react-table';
 import { type VirtualItem, type Virtualizer, type VirtualizerOptions } from '@tanstack/react-virtual';
 import { type AlertProps } from '@mui/material/Alert';
 import { type AutocompleteProps } from '@mui/material/Autocomplete';
@@ -41,7 +41,13 @@ export type Xor<A, B> = Prettify<A & {
 }>;
 export type MRT_DensityState = 'comfortable' | 'compact' | 'spacious';
 export type MRT_ColumnFilterFnsState = Record<string, MRT_FilterOption>;
+export type MRT_RowData = Record<string, any>;
 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 type MRT_ColumnHelper<TData extends MRT_RowData> = {
+    accessor: <TAccessor extends AccessorFn<TData> | DeepKeys<TData>, TValue extends TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never>(accessor: TAccessor, column: MRT_DisplayColumnDef<TData, TValue>) => MRT_ColumnDef<TData, TValue>;
+    display: (column: MRT_DisplayColumnDef<TData>) => MRT_ColumnDef<TData>;
+    group: (column: MRT_GroupColumnDef<TData>) => MRT_ColumnDef<TData>;
+};
 export interface MRT_Localization {
     actions: string;
     and: string;
@@ -133,14 +139,14 @@ export interface MRT_Localization {
     unpin: string;
     unpinAll: string;
 }
-export interface MRT_RowModel<TData extends Record<string, any>> {
+export interface MRT_RowModel<TData extends MRT_RowData> {
     flatRows: MRT_Row<TData>[];
     rows: MRT_Row<TData>[];
     rowsById: {
         [key: string]: MRT_Row<TData>;
     };
 }
-export type MRT_TableInstance<TData extends Record<string, any>> = Omit<Table<TData>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getBottomRows' | 'getCenterLeafColumns' | 'getCenterRows' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getHeaderGroups' | 'getLeftLeafColumns' | 'getPaginationRowModel' | 'getPreFilteredRowModel' | 'getPrePaginationRowModel' | 'getRightLeafColumns' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'getTopRows' | 'options'> & {
+export type MRT_TableInstance<TData extends MRT_RowData> = Omit<Table<TData>, 'getAllColumns' | 'getAllFlatColumns' | 'getAllLeafColumns' | 'getBottomRows' | 'getCenterLeafColumns' | 'getCenterRows' | 'getColumn' | 'getExpandedRowModel' | 'getFlatHeaders' | 'getHeaderGroups' | 'getLeftLeafColumns' | 'getPaginationRowModel' | 'getPreFilteredRowModel' | 'getPrePaginationRowModel' | 'getRightLeafColumns' | 'getRowModel' | 'getSelectedRowModel' | 'getState' | 'getTopRows' | 'options'> & {
     getAllColumns: () => MRT_Column<TData>[];
     getAllFlatColumns: () => MRT_Column<TData>[];
     getAllLeafColumns: () => MRT_Column<TData>[];
@@ -189,11 +195,11 @@ export type MRT_TableInstance<TData extends Record<string, any>> = Omit<Table<TD
     setShowGlobalFilter: Dispatch<SetStateAction<boolean>>;
     setShowToolbarDropZone: Dispatch<SetStateAction<boolean>>;
 };
-export type MRT_DefinedTableOptions<TData extends Record<string, any>> = MRT_TableOptions<TData> & {
+export type MRT_DefinedTableOptions<TData extends MRT_RowData> = MRT_TableOptions<TData> & {
     icons: MRT_Icons;
     localization: MRT_Localization;
 };
-export type MRT_TableState<TData extends Record<string, any>> = TableState & {
+export type MRT_TableState<TData extends MRT_RowData> = TableState & {
     columnFilterFns: MRT_ColumnFilterFnsState;
     creatingRow: MRT_Row<TData> | null;
     density: MRT_DensityState;
@@ -215,52 +221,52 @@ export type MRT_TableState<TData extends Record<string, any>> = TableState & {
     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 MRT_RowData, TValue = unknown> = Omit<ColumnDef<TData, TValue>, 'accessorKey' | 'aggregatedCell' | 'aggregationFn' | 'cell' | 'columns' | 'filterFn' | 'footer' | 'header' | 'id' | 'sortingFn'> & {
     AggregatedCell?: (props: {
-        cell: MRT_Cell<TData>;
-        column: MRT_Column<TData>;
+        cell: MRT_Cell<TData, TValue>;
+        column: MRT_Column<TData, TValue>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Cell?: (props: {
-        cell: MRT_Cell<TData>;
-        column: MRT_Column<TData>;
-        renderedCellValue: ReactNode | number | string;
+        cell: MRT_Cell<TData, TValue>;
+        column: MRT_Column<TData, TValue>;
+        renderedCellValue: ReactNode;
         row: MRT_Row<TData>;
         rowRef?: RefObject<HTMLTableRowElement>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Edit?: (props: {
-        cell: MRT_Cell<TData>;
-        column: MRT_Column<TData>;
+        cell: MRT_Cell<TData, TValue>;
+        column: MRT_Column<TData, TValue>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Filter?: (props: {
-        column: MRT_Column<TData>;
+        column: MRT_Column<TData, TValue>;
         header: MRT_Header<TData>;
         rangeFilterIndex?: number;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Footer?: ((props: {
-        column: MRT_Column<TData>;
+        column: MRT_Column<TData, TValue>;
         footer: MRT_Header<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode) | ReactNode;
     GroupedCell?: (props: {
-        cell: MRT_Cell<TData>;
-        column: MRT_Column<TData>;
+        cell: MRT_Cell<TData, TValue>;
+        column: MRT_Column<TData, TValue>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     Header?: ((props: {
-        column: MRT_Column<TData>;
+        column: MRT_Column<TData, TValue>;
         header: MRT_Header<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode) | ReactNode;
     PlaceholderCell?: (props: {
-        cell: MRT_Cell<TData>;
-        column: MRT_Column<TData>;
+        cell: MRT_Cell<TData, TValue>;
+        column: MRT_Column<TData, TValue>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
@@ -270,7 +276,7 @@ export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TD
      *
      * @example accessorFn: (row) => row.username
      */
-    accessorFn?: (originalRow: TData) => any;
+    accessorFn?: (originalRow: TData) => TValue;
     /**
      * Either an `accessorKey` or a combination of an `accessorFn` and `id` are required for a data column definition.
      * Specify which key in the row this column should use to access the correct data.
@@ -291,7 +297,7 @@ export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TD
      */
     columnDefType?: 'data' | 'display' | 'group';
     columnFilterModeOptions?: Array<LiteralUnion<string & MRT_FilterOption>> | null;
-    columns?: MRT_ColumnDef<TData>[];
+    columns?: MRT_ColumnDef<TData, TValue>[];
     editSelectOptions?: ({
         text: string;
         value: any;
@@ -337,13 +343,13 @@ export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TD
         table: MRT_TableInstance<TData>;
     }) => IconButtonProps) | IconButtonProps;
     muiCopyButtonProps?: ((props: {
-        cell: MRT_Cell<TData>;
+        cell: MRT_Cell<TData, TValue>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ButtonProps) | ButtonProps;
     muiEditTextFieldProps?: ((props: {
-        cell: MRT_Cell<TData>;
+        cell: MRT_Cell<TData, TValue>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
@@ -371,7 +377,7 @@ export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TD
         table: MRT_TableInstance<TData>;
     }) => TextFieldProps) | TextFieldProps;
     muiTableBodyCellProps?: ((props: {
-        cell: MRT_Cell<TData>;
+        cell: MRT_Cell<TData, TValue>;
         column: MRT_Column<TData>;
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
@@ -398,40 +404,44 @@ export type MRT_ColumnDef<TData extends Record<string, any>> = Omit<ColumnDef<TD
     }) => ReactNode[];
     sortingFn?: MRT_SortingFn<TData>;
 };
-export type MRT_DefinedColumnDef<TData extends Record<string, any>> = Omit<MRT_ColumnDef<TData>, 'defaultDisplayColumn' | 'id'> & {
+export type MRT_DisplayColumnDef<TData extends MRT_RowData, TValue = unknown> = Omit<MRT_ColumnDef<TData, TValue>, 'accessorFn' | 'accessorKey'>;
+export type MRT_GroupColumnDef<TData extends MRT_RowData> = MRT_DisplayColumnDef<TData, any> & {
+    columns: MRT_ColumnDef<TData>[];
+};
+export type MRT_DefinedColumnDef<TData extends MRT_RowData, TValue = unknown> = Omit<MRT_ColumnDef<TData, TValue>, 'defaultDisplayColumn' | 'id'> & {
     _filterFn: MRT_FilterOption;
-    defaultDisplayColumn: Partial<MRT_ColumnDef<TData>>;
+    defaultDisplayColumn: Partial<MRT_ColumnDef<TData, TValue>>;
     id: string;
 };
-export type MRT_Column<TData extends Record<string, any>> = Omit<Column<TData, unknown>, 'columnDef' | 'columns' | 'filterFn' | 'footer' | 'header'> & {
-    columnDef: MRT_DefinedColumnDef<TData>;
-    columns?: MRT_Column<TData>[];
+export type MRT_Column<TData extends MRT_RowData, TValue = unknown> = Omit<Column<TData, TValue>, 'columnDef' | 'columns' | 'filterFn' | 'footer' | 'header'> & {
+    columnDef: MRT_DefinedColumnDef<TData, TValue>;
+    columns?: MRT_Column<TData, TValue>[];
     filterFn?: MRT_FilterFn<TData>;
     footer: string;
     header: string;
 };
-export type MRT_Header<TData extends Record<string, any>> = Omit<Header<TData, unknown>, 'column'> & {
+export type MRT_Header<TData extends MRT_RowData> = Omit<Header<TData, unknown>, 'column'> & {
     column: MRT_Column<TData>;
 };
-export type MRT_HeaderGroup<TData extends Record<string, any>> = Omit<HeaderGroup<TData>, 'headers'> & {
+export type MRT_HeaderGroup<TData extends MRT_RowData> = Omit<HeaderGroup<TData>, 'headers'> & {
     headers: MRT_Header<TData>[];
 };
-export type MRT_Row<TData extends Record<string, any>> = Omit<Row<TData>, '_valuesCache' | 'getAllCells' | 'getVisibleCells' | 'subRows'> & {
+export type MRT_Row<TData extends MRT_RowData> = Omit<Row<TData>, '_valuesCache' | 'getAllCells' | 'getVisibleCells' | 'subRows'> & {
     _valuesCache: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
     getAllCells: () => MRT_Cell<TData>[];
     getVisibleCells: () => MRT_Cell<TData>[];
     subRows?: MRT_Row<TData>[];
 };
-export type MRT_Cell<TData extends Record<string, any>> = Omit<Cell<TData, unknown>, 'column' | 'row'> & {
-    column: MRT_Column<TData>;
+export type MRT_Cell<TData extends MRT_RowData, TValue = unknown> = Omit<Cell<TData, TValue>, 'column' | 'row'> & {
+    column: MRT_Column<TData, TValue>;
     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 MRT_RowData> = AggregationFn<TData> | MRT_AggregationOption;
 export type MRT_SortingOption = LiteralUnion<string & keyof typeof MRT_SortingFns>;
-export type MRT_SortingFn<TData extends Record<string, any>> = MRT_SortingOption | SortingFn<TData>;
+export type MRT_SortingFn<TData extends MRT_RowData> = MRT_SortingOption | SortingFn<TData>;
 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 MRT_RowData> = FilterFn<TData> | MRT_FilterOption;
 export type MRT_InternalFilterOption = {
     divider: boolean;
     label: string;
@@ -448,7 +458,7 @@ export type MRT_DisplayColumnIds = 'mrt-row-actions' | 'mrt-row-drag' | 'mrt-row
  * See the full props list on the official docs site:
  * @link https://www.material-react-table.com/docs/api/props
  */
-export type MRT_TableOptions<TData extends Record<string, any>> = Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'defaultColumn' | 'enableRowSelection' | 'expandRowsFn' | 'getRowId' | 'globalFilterFn' | 'initialState' | 'onStateChange' | 'state'> & {
+export type MRT_TableOptions<TData extends MRT_RowData> = Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'defaultColumn' | 'enableRowSelection' | 'expandRowsFn' | 'getRowId' | 'globalFilterFn' | 'initialState' | 'onStateChange' | 'state'> & {
     columnFilterDisplayMode?: 'custom' | 'popover' | 'subheader';
     columnFilterModeOptions?: Array<LiteralUnion<string & MRT_FilterOption>> | null;
     columnVirtualizerInstanceRef?: MutableRefObject<Virtualizer<HTMLDivElement, HTMLTableCellElement> | null>;
@@ -465,7 +475,7 @@ export type MRT_TableOptions<TData extends Record<string, any>> = Omit<Partial<T
      * See all Columns Options on the official docs site:
      * @link https://www.material-react-table.com/docs/api/column-options
      */
-    columns: MRT_ColumnDef<TData>[];
+    columns: MRT_ColumnDef<TData, any>[];
     createDisplayMode?: 'custom' | 'modal' | 'row';
     /**
      * Pass your data as an array of objects. Objects can theoretically be any shape, but it's best to keep them consistent.

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

@@ -1,2 +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>;
+import { type MRT_RowData, type MRT_TableInstance, type MRT_TableOptions } from './types';
+export declare const useMaterialReactTable: <TData extends MRT_RowData>(tableOptions: MRT_TableOptions<TData>) => MRT_TableInstance<TData>;