@tanstack/react-table 8.0.0-alpha.79 → 8.0.0-alpha.82

package/build/cjs/react-table/src/index.js

@@ -102,11 +102,13 @@ exports.Pinning = index.Pinning;
 exports.RowSelection = index.RowSelection;
 exports.Sorting = index.Sorting;
 exports.Visibility = index.Visibility;
+exports.aggregationFns = index.aggregationFns;
 exports.buildHeaderGroups = index.buildHeaderGroups;
 exports.createTableFactory = index.createTableFactory;
 exports.createTableInstance = index.createTableInstance;
 exports.defaultColumnSizing = index.defaultColumnSizing;
 exports.expandRows = index.expandRows;
+exports.filterFns = index.filterFns;
 exports.flattenBy = index.flattenBy;
 exports.functionalUpdate = index.functionalUpdate;
 exports.getCoreRowModel = index.getCoreRowModel;
@@ -121,12 +123,15 @@ exports.getSortedRowModel = index.getSortedRowModel;
 exports.isFunction = index.isFunction;
 exports.isRowSelected = index.isRowSelected;
 exports.makeStateUpdater = index.makeStateUpdater;
+exports.mean = index.mean;
 exports.memo = index.memo;
 exports.noop = index.noop;
 exports.orderColumns = index.orderColumns;
 exports.passiveEventSupported = index.passiveEventSupported;
+exports.reSplitAlphaNumeric = index.reSplitAlphaNumeric;
 exports.selectRowsFn = index.selectRowsFn;
 exports.shouldAutoRemoveFilter = index.shouldAutoRemoveFilter;
+exports.sortingFns = index.sortingFns;
 exports.createTable = createTable;
 exports.render = render;
 exports.useTableInstance = useTableInstance;

package/build/cjs/react-table/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/index.tsx"],"sourcesContent":["import * as React from 'react'\nexport * from '@tanstack/table-core'\n\nimport {\n  createTableInstance,\n  TableOptions,\n  TableInstance,\n  Table,\n  TableGenerics,\n  createTableFactory,\n  Overwrite,\n  PartialKeys,\n} from '@tanstack/table-core'\n\nexport type Renderable<TProps> =\n  | React.ReactNode\n  | React.FunctionComponent<TProps>\n  | React.Component<TProps>\n\nexport type Render = <TProps extends {}>(\n  Comp: Renderable<TProps>,\n  props: TProps\n) => React.ReactNode | JSX.Element\n\nexport type ReactTableGenerics = Overwrite<\n  TableGenerics,\n  { Renderer: Render; Rendered: ReturnType<Render> }\n>\n\n//\n\nexport const render: Render = (Comp, props) =>\n  !Comp ? null : isReactComponent(Comp) ? <Comp {...props} /> : Comp\n\nfunction isReactComponent(component: unknown): component is React.FC {\n  return (\n    isClassComponent(component) ||\n    typeof component === 'function' ||\n    isExoticComponent(component)\n  )\n}\n\nfunction isClassComponent(component: any) {\n  return (\n    typeof component === 'function' &&\n    (() => {\n      const proto = Object.getPrototypeOf(component)\n      return proto.prototype && proto.prototype.isReactComponent\n    })()\n  )\n}\n\nfunction isExoticComponent(component: any) {\n  return (\n    typeof component === 'object' &&\n    typeof component.$$typeof === 'symbol' &&\n    ['react.memo', 'react.forward_ref'].includes(component.$$typeof.description)\n  )\n}\n\nexport const createTable = createTableFactory({ render })\n\n// const useIsomorphicLayoutEffect =\n//   typeof document !== 'undefined' ? React.useLayoutEffect : React.useEffect\n\nexport type UseTableInstanceOptions<TGenerics extends ReactTableGenerics> =\n  PartialKeys<\n    Omit<TableOptions<TGenerics>, 'render'>,\n    'state' | 'onStateChange'\n  >\n\nexport function useTableInstance<TGenerics extends ReactTableGenerics>(\n  table: Table<TGenerics>,\n  options: UseTableInstanceOptions<TGenerics>\n): TableInstance<TGenerics> {\n  // Compose in the generic options to the user options\n  const resolvedOptions: TableOptions<TGenerics> = {\n    ...table.options,\n    state: {}, // Dummy state\n    onStateChange: () => {}, // noop\n    render,\n    ...options,\n  }\n\n  // Create a new table instance and store it in state\n  const [instanceRef] = React.useState(() => ({\n    current: createTableInstance<TGenerics>(resolvedOptions),\n  }))\n\n  // By default, manage table state here using the instance's initial state\n  const [state, setState] = React.useState(\n    () => instanceRef.current.initialState\n  )\n\n  // Compose the default state above with any user state. This will allow the user\n  // to only control a subset of the state if desired.\n  instanceRef.current.setOptions(prev => ({\n    ...prev,\n    ...options,\n    state: {\n      ...state,\n      ...options.state,\n    },\n    // Similarly, we'll maintain both our internal state and any user-provided\n    // state.\n    onStateChange: updater => {\n      setState(updater)\n      options.onStateChange?.(updater)\n    },\n  }))\n\n  return instanceRef.current\n}\n"],"names":["render","Comp","props","isReactComponent","React","component","isClassComponent","isExoticComponent","proto","Object","getPrototypeOf","prototype","$$typeof","includes","description","createTable","createTableFactory","useTableInstance","table","options","resolvedOptions","state","onStateChange","instanceRef","useState","current","createTableInstance","setState","initialState","setOptions","prev","updater"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA;AAEO,MAAMA,MAAc,GAAG,CAACC,IAAD,EAAOC,KAAP,KAC5B,CAACD,IAAD,GAAQ,IAAR,GAAeE,gBAAgB,CAACF,IAAD,CAAhB,gBAAyBG,gBAAA,CAAA,aAAA,CAAC,IAAD,EAAUF,KAAV,CAAzB,GAA+CD,KADzD;;AAGP,SAASE,gBAAT,CAA0BE,SAA1B,EAAqE;AACnE,EAAA,OACEC,gBAAgB,CAACD,SAAD,CAAhB,IACA,OAAOA,SAAP,KAAqB,UADrB,IAEAE,iBAAiB,CAACF,SAAD,CAHnB,CAAA;AAKD,CAAA;;AAED,SAASC,gBAAT,CAA0BD,SAA1B,EAA0C;AACxC,EAAA,OACE,OAAOA,SAAP,KAAqB,UAArB,IACA,CAAC,MAAM;AACL,IAAA,MAAMG,KAAK,GAAGC,MAAM,CAACC,cAAP,CAAsBL,SAAtB,CAAd,CAAA;AACA,IAAOG,OAAAA,KAAK,CAACG,SAAN,IAAmBH,KAAK,CAACG,SAAN,CAAgBR,gBAA1C,CAAA;AACD,GAHD,GAFF,CAAA;AAOD,CAAA;;AAED,SAASI,iBAAT,CAA2BF,SAA3B,EAA2C;AACzC,EACE,OAAA,OAAOA,SAAP,KAAqB,QAArB,IACA,OAAOA,SAAS,CAACO,QAAjB,KAA8B,QAD9B,IAEA,CAAC,YAAD,EAAe,mBAAf,CAAA,CAAoCC,QAApC,CAA6CR,SAAS,CAACO,QAAV,CAAmBE,WAAhE,CAHF,CAAA;AAKD,CAAA;;AAEYC,MAAAA,WAAW,GAAGC,wBAAkB,CAAC;AAAEhB,EAAAA,MAAAA;AAAF,CAAD;AAG7C;;AAQO,SAASiB,gBAAT,CACLC,KADK,EAELC,OAFK,EAGqB;AAC1B;AACA,EAAA,MAAMC,eAAwC,GAAG,EAC/C,GAAGF,KAAK,CAACC,OADsC;AAE/CE,IAAAA,KAAK,EAAE,EAFwC;AAEpC;AACXC,IAAAA,aAAa,EAAE,MAAM,EAH0B;AAGtB;AACzBtB,IAAAA,MAJ+C;AAK/C,IAAGmB,GAAAA,OAAAA;AAL4C,GAAjD,CAF0B;;AAW1B,EAAA,MAAM,CAACI,WAAD,CAAA,GAAgBnB,gBAAK,CAACoB,QAAN,CAAe,OAAO;AAC1CC,IAAAA,OAAO,EAAEC,yBAAmB,CAAYN,eAAZ,CAAA;AADc,GAAP,CAAf,CAAtB,CAX0B;;AAgB1B,EAAA,MAAM,CAACC,KAAD,EAAQM,QAAR,CAAA,GAAoBvB,gBAAK,CAACoB,QAAN,CACxB,MAAMD,WAAW,CAACE,OAAZ,CAAoBG,YADF,CAA1B,CAhB0B;AAqB1B;;AACAL,EAAAA,WAAW,CAACE,OAAZ,CAAoBI,UAApB,CAA+BC,IAAI,KAAK,EACtC,GAAGA,IADmC;AAEtC,IAAA,GAAGX,OAFmC;AAGtCE,IAAAA,KAAK,EAAE,EACL,GAAGA,KADE;AAEL,MAAA,GAAGF,OAAO,CAACE,KAAAA;AAFN,KAH+B;AAOtC;AACA;AACAC,IAAAA,aAAa,EAAES,OAAO,IAAI;AACxBJ,MAAAA,QAAQ,CAACI,OAAD,CAAR,CAAA;AACAZ,MAAAA,OAAO,CAACG,aAAR,IAAA,IAAA,GAAA,KAAA,CAAA,GAAAH,OAAO,CAACG,aAAR,CAAwBS,OAAxB,CAAA,CAAA;AACD,KAAA;AAZqC,GAAL,CAAnC,CAAA,CAAA;AAeA,EAAOR,OAAAA,WAAW,CAACE,OAAnB,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":["../../../../src/index.tsx"],"sourcesContent":["import * as React from 'react'\nexport * from '@tanstack/table-core'\n\nimport {\n  createTableInstance,\n  TableOptions,\n  TableInstance,\n  Table,\n  TableGenerics,\n  createTableFactory,\n  Overwrite,\n  PartialKeys,\n} from '@tanstack/table-core'\n\nexport type Renderable<TProps> =\n  | React.ReactNode\n  | React.FunctionComponent<TProps>\n  | React.Component<TProps>\n\nexport type Render = <TProps extends {}>(\n  Comp: Renderable<TProps>,\n  props: TProps\n) => React.ReactNode | JSX.Element\n\nexport type ReactTableGenerics = Overwrite<\n  TableGenerics,\n  { Renderer: Render; Rendered: ReturnType<Render> }\n>\n\n//\n\nexport const render: Render = (Comp, props) =>\n  !Comp ? null : isReactComponent(Comp) ? <Comp {...props} /> : Comp\n\nfunction isReactComponent(component: unknown): component is React.FC {\n  return (\n    isClassComponent(component) ||\n    typeof component === 'function' ||\n    isExoticComponent(component)\n  )\n}\n\nfunction isClassComponent(component: any) {\n  return (\n    typeof component === 'function' &&\n    (() => {\n      const proto = Object.getPrototypeOf(component)\n      return proto.prototype && proto.prototype.isReactComponent\n    })()\n  )\n}\n\nfunction isExoticComponent(component: any) {\n  return (\n    typeof component === 'object' &&\n    typeof component.$$typeof === 'symbol' &&\n    ['react.memo', 'react.forward_ref'].includes(component.$$typeof.description)\n  )\n}\n\nexport const createTable = createTableFactory({ render })\n\n// const useIsomorphicLayoutEffect =\n//   typeof document !== 'undefined' ? React.useLayoutEffect : React.useEffect\n\nexport type UseTableInstanceOptions<TGenerics extends ReactTableGenerics> =\n  PartialKeys<\n    Omit<TableOptions<TGenerics>, 'render'>,\n    'state' | 'onStateChange'\n  >\n\nexport function useTableInstance<TGenerics extends ReactTableGenerics>(\n  table: Table<TGenerics>,\n  options: UseTableInstanceOptions<TGenerics>\n): TableInstance<TGenerics> {\n  // Compose in the generic options to the user options\n  const resolvedOptions: TableOptions<TGenerics> = {\n    ...table.options,\n    state: {}, // Dummy state\n    onStateChange: () => {}, // noop\n    render,\n    ...options,\n  }\n\n  // Create a new table instance and store it in state\n  const [instanceRef] = React.useState(() => ({\n    current: createTableInstance<TGenerics>(resolvedOptions),\n  }))\n\n  // By default, manage table state here using the instance's initial state\n  const [state, setState] = React.useState(\n    () => instanceRef.current.initialState\n  )\n\n  // Compose the default state above with any user state. This will allow the user\n  // to only control a subset of the state if desired.\n  instanceRef.current.setOptions(prev => ({\n    ...prev,\n    ...options,\n    state: {\n      ...state,\n      ...options.state,\n    },\n    // Similarly, we'll maintain both our internal state and any user-provided\n    // state.\n    onStateChange: updater => {\n      setState(updater)\n      options.onStateChange?.(updater)\n    },\n  }))\n\n  return instanceRef.current\n}\n"],"names":["render","Comp","props","isReactComponent","React","component","isClassComponent","isExoticComponent","proto","Object","getPrototypeOf","prototype","$$typeof","includes","description","createTable","createTableFactory","useTableInstance","table","options","resolvedOptions","state","onStateChange","instanceRef","useState","current","createTableInstance","setState","initialState","setOptions","prev","updater"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA;AAEO,MAAMA,MAAc,GAAG,CAACC,IAAD,EAAOC,KAAP,KAC5B,CAACD,IAAD,GAAQ,IAAR,GAAeE,gBAAgB,CAACF,IAAD,CAAhB,gBAAyBG,gBAAA,CAAA,aAAA,CAAC,IAAD,EAAUF,KAAV,CAAzB,GAA+CD,KADzD;;AAGP,SAASE,gBAAT,CAA0BE,SAA1B,EAAqE;AACnE,EAAA,OACEC,gBAAgB,CAACD,SAAD,CAAhB,IACA,OAAOA,SAAP,KAAqB,UADrB,IAEAE,iBAAiB,CAACF,SAAD,CAHnB,CAAA;AAKD,CAAA;;AAED,SAASC,gBAAT,CAA0BD,SAA1B,EAA0C;AACxC,EAAA,OACE,OAAOA,SAAP,KAAqB,UAArB,IACA,CAAC,MAAM;AACL,IAAA,MAAMG,KAAK,GAAGC,MAAM,CAACC,cAAP,CAAsBL,SAAtB,CAAd,CAAA;AACA,IAAOG,OAAAA,KAAK,CAACG,SAAN,IAAmBH,KAAK,CAACG,SAAN,CAAgBR,gBAA1C,CAAA;AACD,GAHD,GAFF,CAAA;AAOD,CAAA;;AAED,SAASI,iBAAT,CAA2BF,SAA3B,EAA2C;AACzC,EACE,OAAA,OAAOA,SAAP,KAAqB,QAArB,IACA,OAAOA,SAAS,CAACO,QAAjB,KAA8B,QAD9B,IAEA,CAAC,YAAD,EAAe,mBAAf,CAAA,CAAoCC,QAApC,CAA6CR,SAAS,CAACO,QAAV,CAAmBE,WAAhE,CAHF,CAAA;AAKD,CAAA;;AAEYC,MAAAA,WAAW,GAAGC,wBAAkB,CAAC;AAAEhB,EAAAA,MAAAA;AAAF,CAAD;AAG7C;;AAQO,SAASiB,gBAAT,CACLC,KADK,EAELC,OAFK,EAGqB;AAC1B;AACA,EAAA,MAAMC,eAAwC,GAAG,EAC/C,GAAGF,KAAK,CAACC,OADsC;AAE/CE,IAAAA,KAAK,EAAE,EAFwC;AAEpC;AACXC,IAAAA,aAAa,EAAE,MAAM,EAH0B;AAGtB;AACzBtB,IAAAA,MAJ+C;AAK/C,IAAGmB,GAAAA,OAAAA;AAL4C,GAAjD,CAF0B;;AAW1B,EAAA,MAAM,CAACI,WAAD,CAAA,GAAgBnB,gBAAK,CAACoB,QAAN,CAAe,OAAO;AAC1CC,IAAAA,OAAO,EAAEC,yBAAmB,CAAYN,eAAZ,CAAA;AADc,GAAP,CAAf,CAAtB,CAX0B;;AAgB1B,EAAA,MAAM,CAACC,KAAD,EAAQM,QAAR,CAAA,GAAoBvB,gBAAK,CAACoB,QAAN,CACxB,MAAMD,WAAW,CAACE,OAAZ,CAAoBG,YADF,CAA1B,CAhB0B;AAqB1B;;AACAL,EAAAA,WAAW,CAACE,OAAZ,CAAoBI,UAApB,CAA+BC,IAAI,KAAK,EACtC,GAAGA,IADmC;AAEtC,IAAA,GAAGX,OAFmC;AAGtCE,IAAAA,KAAK,EAAE,EACL,GAAGA,KADE;AAEL,MAAA,GAAGF,OAAO,CAACE,KAAAA;AAFN,KAH+B;AAOtC;AACA;AACAC,IAAAA,aAAa,EAAES,OAAO,IAAI;AACxBJ,MAAAA,QAAQ,CAACI,OAAD,CAAR,CAAA;AACAZ,MAAAA,OAAO,CAACG,aAAR,IAAA,IAAA,GAAA,KAAA,CAAA,GAAAH,OAAO,CAACG,aAAR,CAAwBS,OAAxB,CAAA,CAAA;AACD,KAAA;AAZqC,GAAL,CAAnC,CAAA,CAAA;AAeA,EAAOR,OAAAA,WAAW,CAACE,OAAnB,CAAA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/build/cjs/table-core/build/esm/index.js

@@ -300,7 +300,7 @@ const Rows = {
             const column = instance.getColumn(columnId);
 
             if (!column.accessorFn) {
-              throw new Error();
+              return undefined;
             }
 
             row.valuesCache[columnId] = column.accessorFn(row.original, rowIndex);
@@ -1097,7 +1097,8 @@ const Filters = {
   },
   createRow: (row, instance) => {
     return {
-      columnFilterMap: {},
+      columnFilters: {},
+      columnFiltersMeta: {},
       subRowsByFacetId: {}
     };
   },
@@ -2339,7 +2340,7 @@ const Sorting = {
   createColumn: (column, instance) => {
     return {
       getAutoSortingFn: () => {
-        const firstRows = instance.getFilteredRowModel().flatRows.slice(100);
+        const firstRows = instance.getFilteredRowModel().flatRows.slice(10);
         let isString = false;
 
         for (const row of firstRows) {
@@ -3187,6 +3188,7 @@ function createTable(_, __, options) {
     setRowType: () => table,
     setTableMetaType: () => table,
     setColumnMetaType: () => table,
+    setFilterMetaType: () => table,
     setOptions: newOptions => createTable(_, __, { ...options,
       ...newOptions
     }),
@@ -3314,7 +3316,7 @@ function filterRowModelFromLeafs(rowsToFilter, filterRow, instance) {
 
       if ((_row$subRows = row.subRows) != null && _row$subRows.length) {
         newRow = instance.createRow(row.id, row.original, row.index, row.depth);
-        newRow.columnFilterMap = row.columnFilterMap;
+        newRow.columnFilters = row.columnFilters;
         newRow.subRows = recurseFilterRows(row.subRows, depth + 1);
 
         if (!newRow.subRows.length) {
@@ -3387,6 +3389,11 @@ function filterRowModelFromRoot(rowsToFilter, filterRow, instance) {
 function getFilteredRowModel() {
   return instance => memo(() => [instance.getPreFilteredRowModel(), instance.getState().columnFilters, instance.getState().globalFilter], (rowModel, columnFilters, globalFilter) => {
     if (!rowModel.rows.length || !(columnFilters != null && columnFilters.length) && !globalFilter) {
+      for (let i = 0; i < rowModel.flatRows.length; i++) {
+        rowModel.flatRows[i].columnFilters = {};
+        rowModel.flatRows[i].columnFiltersMeta = {};
+      }
+
       return rowModel;
     }
 
@@ -3441,28 +3448,34 @@ function getFilteredRowModel() {
 
     for (let j = 0; j < rowModel.flatRows.length; j++) {
       const row = rowModel.flatRows[j];
-      row.columnFilterMap = {};
+      row.columnFilters = {};
 
       if (resolvedColumnFilters.length) {
         for (let i = 0; i < resolvedColumnFilters.length; i++) {
-          currentColumnFilter = resolvedColumnFilters[i]; // Tag the row with the column filter state
+          currentColumnFilter = resolvedColumnFilters[i];
+          const id = currentColumnFilter.id; // Tag the row with the column filter state
 
-          row.columnFilterMap[currentColumnFilter.id] = currentColumnFilter.filterFn(row, currentColumnFilter.id, currentColumnFilter.resolvedValue);
+          row.columnFilters[id] = currentColumnFilter.filterFn(row, id, currentColumnFilter.resolvedValue, filterMeta => {
+            row.columnFiltersMeta[id] = filterMeta;
+          });
         }
       }
 
       if (resolvedGlobalFilters.length) {
         for (let i = 0; i < resolvedGlobalFilters.length; i++) {
-          currentGlobalFilter = resolvedGlobalFilters[i]; // Tag the row with the first truthy global filter state
+          currentGlobalFilter = resolvedGlobalFilters[i];
+          const id = currentGlobalFilter.id; // Tag the row with the first truthy global filter state
 
-          if (currentGlobalFilter.filterFn(row, currentGlobalFilter.id, currentGlobalFilter.resolvedValue)) {
-            row.columnFilterMap.__global__ = true;
+          if (currentGlobalFilter.filterFn(row, id, currentGlobalFilter.resolvedValue, filterMeta => {
+            row.columnFiltersMeta[id] = filterMeta;
+          })) {
+            row.columnFilters.__global__ = true;
             break;
           }
         }
 
-        if (row.columnFilterMap.__global__ !== true) {
-          row.columnFilterMap.__global__ = false;
+        if (row.columnFilters.__global__ !== true) {
+          row.columnFilters.__global__ = false;
         }
       }
     }
@@ -3470,7 +3483,7 @@ function getFilteredRowModel() {
     const filterRowsImpl = row => {
       // Horizontally filter rows through each column
       for (let i = 0; i < filterableIds.length; i++) {
-        if (row.columnFilterMap[filterableIds[i]] === false) {
+        if (row.columnFilters[filterableIds[i]] === false) {
           return false;
         }
       }
@@ -3504,7 +3517,7 @@ function getFacetedRowModel() {
     const filterRowsImpl = row => {
       // Horizontally filter rows through each column
       for (let i = 0; i < filterableIds.length; i++) {
-        if (row.columnFilterMap[filterableIds[i]] === false) {
+        if (row.columnFilters[filterableIds[i]] === false) {
           return false;
         }
       }
@@ -3923,11 +3936,13 @@ exports.Pinning = Pinning;
 exports.RowSelection = RowSelection;
 exports.Sorting = Sorting;
 exports.Visibility = Visibility;
+exports.aggregationFns = aggregationFns;
 exports.buildHeaderGroups = buildHeaderGroups;
 exports.createTableFactory = createTableFactory;
 exports.createTableInstance = createTableInstance;
 exports.defaultColumnSizing = defaultColumnSizing;
 exports.expandRows = expandRows;
+exports.filterFns = filterFns;
 exports.flattenBy = flattenBy;
 exports.functionalUpdate = functionalUpdate;
 exports.getCoreRowModel = getCoreRowModel;
@@ -3942,10 +3957,13 @@ exports.getSortedRowModel = getSortedRowModel;
 exports.isFunction = isFunction;
 exports.isRowSelected = isRowSelected;
 exports.makeStateUpdater = makeStateUpdater;
+exports.mean = mean;
 exports.memo = memo;
 exports.noop = noop;
 exports.orderColumns = orderColumns;
 exports.passiveEventSupported = passiveEventSupported;
+exports.reSplitAlphaNumeric = reSplitAlphaNumeric;
 exports.selectRowsFn = selectRowsFn;
 exports.shouldAutoRemoveFilter = shouldAutoRemoveFilter;
+exports.sortingFns = sortingFns;
 //# sourceMappingURL=index.js.map