@tanstack/react-table 8.0.0-alpha.9 → 8.0.0-beta.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tanstack/react-table",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.9",
-  "description": "Hooks for building lightweight, fast and extendable datagrids for React",
+  "version": "8.0.0-beta.0",
+  "description": "Headless UI for building powerful tables & datagrids for React.",
   "license": "MIT",
-  "homepage": "https://github.com/tanstack/react-table#readme",
+  "homepage": "https://github.com/tanstack/table#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tanstack/react-table.git"
+    "url": "git+https://github.com/tanstack/table.git"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -23,9 +23,10 @@
     "url": "https://github.com/sponsors/tannerlinsley"
   },
   "module": "build/esm/index.js",
-  "main": "build/cjs/index.js",
-  "browser": "build/umd/index.production.min.js",
+  "main": "build/cjs/react-table/src/index.js",
+  "browser": "build/umd/index.production.js",
   "types": "build/types/index.d.ts",
+  "sideEffects": false,
   "engines": {
     "node": ">=12"
   },
@@ -33,6 +34,9 @@
     "build",
     "src"
   ],
+  "dependencies": {
+    "@tanstack/table-core": "8.0.0-beta.0"
+  },
   "peerDependencies": {
     "react": ">=16",
     "react-dom": ">=16"

package/src/index.tsx

@@ -1,9 +1,111 @@
-export * from './types'
-export * from './utils'
-export * from './utils/columnFilterRowsFn'
-export * from './utils/globalFilterRowsFn'
-export * from './utils/sortRowsFn'
-export * from './utils/groupRowsFn'
-export * from './utils/expandRowsFn'
-export * from './utils/paginateRowsFn'
-export * from './createTable'
+import * as React from 'react'
+export * from '@tanstack/table-core'
+
+import {
+  createTableInstance,
+  TableOptions,
+  TableInstance,
+  Table,
+  TableGenerics,
+  createTableFactory,
+  Overwrite,
+  PartialKeys,
+  TableOptionsResolved,
+} from '@tanstack/table-core'
+
+export type Renderable<TProps> =
+  | React.ReactNode
+  | React.FunctionComponent<TProps>
+  | React.Component<TProps>
+
+export type Render = <TProps extends {}>(
+  Comp: Renderable<TProps>,
+  props: TProps
+) => React.ReactNode | JSX.Element
+
+export type ReactTableGenerics = Overwrite<
+  TableGenerics,
+  { Renderer: Render; Rendered: ReturnType<Render> }
+>
+
+//
+
+export const render: Render = (Comp, props) =>
+  !Comp ? null : isReactComponent(Comp) ? <Comp {...props} /> : Comp
+
+function isReactComponent(component: unknown): component is React.FC {
+  return (
+    isClassComponent(component) ||
+    typeof component === 'function' ||
+    isExoticComponent(component)
+  )
+}
+
+function isClassComponent(component: any) {
+  return (
+    typeof component === 'function' &&
+    (() => {
+      const proto = Object.getPrototypeOf(component)
+      return proto.prototype && proto.prototype.isReactComponent
+    })()
+  )
+}
+
+function isExoticComponent(component: any) {
+  return (
+    typeof component === 'object' &&
+    typeof component.$$typeof === 'symbol' &&
+    ['react.memo', 'react.forward_ref'].includes(component.$$typeof.description)
+  )
+}
+
+export const createTable = createTableFactory({ render })
+
+// const useIsomorphicLayoutEffect =
+//   typeof document !== 'undefined' ? React.useLayoutEffect : React.useEffect
+
+export type UseTableInstanceOptions<TGenerics extends ReactTableGenerics> =
+  TableOptions<TGenerics>
+
+export function useTableInstance<TGenerics extends ReactTableGenerics>(
+  table: Table<TGenerics>,
+  options: UseTableInstanceOptions<TGenerics>
+): TableInstance<TGenerics> {
+  // Compose in the generic options to the user options
+  const resolvedOptions: TableOptionsResolved<TGenerics> = {
+    ...table.options,
+    state: {}, // Dummy state
+    onStateChange: () => {}, // noop
+    render,
+    ...options,
+  }
+
+  // Create a new table instance and store it in state
+  const [instanceRef] = React.useState(() => ({
+    current: createTableInstance<TGenerics>(resolvedOptions),
+  }))
+
+  // By default, manage table state here using the instance's initial state
+  const [state, setState] = React.useState(
+    () => instanceRef.current.initialState
+  )
+
+  // Compose the default state above with any user state. This will allow the user
+  // to only control a subset of the state if desired.
+  instanceRef.current.setOptions(prev => ({
+    ...prev,
+    ...options,
+    state: {
+      ...state,
+      ...options.state,
+    },
+    // Similarly, we'll maintain both our internal state and any user-provided
+    // state.
+    onStateChange: updater => {
+      setState(updater)
+      options.onStateChange?.(updater)
+    },
+  }))
+
+  return instanceRef.current
+}

package/build/cjs/_virtual/_rollupPluginBabelHelpers.js

@@ -1,112 +0,0 @@
-/**
- * react-table
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function _extends() {
-  _extends = Object.assign || function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
-    }
-
-    return target;
-  };
-
-  return _extends.apply(this, arguments);
-}
-
-function _objectWithoutPropertiesLoose(source, excluded) {
-  if (source == null) return {};
-  var target = {};
-  var sourceKeys = Object.keys(source);
-  var key, i;
-
-  for (i = 0; i < sourceKeys.length; i++) {
-    key = sourceKeys[i];
-    if (excluded.indexOf(key) >= 0) continue;
-    target[key] = source[key];
-  }
-
-  return target;
-}
-
-function _unsupportedIterableToArray(o, minLen) {
-  if (!o) return;
-  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
-  var n = Object.prototype.toString.call(o).slice(8, -1);
-  if (n === "Object" && o.constructor) n = o.constructor.name;
-  if (n === "Map" || n === "Set") return Array.from(o);
-  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
-}
-
-function _arrayLikeToArray(arr, len) {
-  if (len == null || len > arr.length) len = arr.length;
-
-  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
-
-  return arr2;
-}
-
-function _createForOfIteratorHelperLoose(o, allowArrayLike) {
-  var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"];
-  if (it) return (it = it.call(o)).next.bind(it);
-
-  if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {
-    if (it) o = it;
-    var i = 0;
-    return function () {
-      if (i >= o.length) return {
-        done: true
-      };
-      return {
-        done: false,
-        value: o[i++]
-      };
-    };
-  }
-
-  throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-
-function _toPrimitive(input, hint) {
-  if (typeof input !== "object" || input === null) return input;
-  var prim = input[Symbol.toPrimitive];
-
-  if (prim !== undefined) {
-    var res = prim.call(input, hint || "default");
-    if (typeof res !== "object") return res;
-    throw new TypeError("@@toPrimitive must return a primitive value.");
-  }
-
-  return (hint === "string" ? String : Number)(input);
-}
-
-function _toPropertyKey(arg) {
-  var key = _toPrimitive(arg, "string");
-
-  return typeof key === "symbol" ? key : String(key);
-}
-
-exports.arrayLikeToArray = _arrayLikeToArray;
-exports.createForOfIteratorHelperLoose = _createForOfIteratorHelperLoose;
-exports["extends"] = _extends;
-exports.objectWithoutPropertiesLoose = _objectWithoutPropertiesLoose;
-exports.toPrimitive = _toPrimitive;
-exports.toPropertyKey = _toPropertyKey;
-exports.unsupportedIterableToArray = _unsupportedIterableToArray;
-//# sourceMappingURL=_rollupPluginBabelHelpers.js.map

package/build/cjs/_virtual/_rollupPluginBabelHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/build/cjs/aggregationTypes.js

@@ -1,130 +0,0 @@
-/**
- * react-table
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _rollupPluginBabelHelpers = require('./_virtual/_rollupPluginBabelHelpers.js');
-
-var aggregationTypes = {
-  sum: sum,
-  min: min,
-  max: max,
-  extent: extent,
-  mean: mean,
-  median: median,
-  unique: unique,
-  uniqueCount: uniqueCount,
-  count: count
-};
-
-function sum(_leafValues, childValues) {
-  // It's faster to just add the aggregations together instead of
-  // process leaf nodes individually
-  return childValues.reduce(function (sum, next) {
-    return sum + (typeof next === 'number' ? next : 0);
-  }, 0);
-}
-
-function min(_leafValues, childValues) {
-  var min;
-
-  for (var _iterator = _rollupPluginBabelHelpers.createForOfIteratorHelperLoose(childValues), _step; !(_step = _iterator()).done;) {
-    var value = _step.value;
-
-    if (value != null && (min > value || min === undefined && value >= value)) {
-      min = value;
-    }
-  }
-
-  return min;
-}
-
-function max(_leafValues, childValues) {
-  var max;
-
-  for (var _iterator2 = _rollupPluginBabelHelpers.createForOfIteratorHelperLoose(childValues), _step2; !(_step2 = _iterator2()).done;) {
-    var value = _step2.value;
-
-    if (value != null && (max < value || max === undefined && value >= value)) {
-      max = value;
-    }
-  }
-
-  return max;
-}
-
-function extent(_leafValues, childValues) {
-  var min;
-  var max;
-
-  for (var _iterator3 = _rollupPluginBabelHelpers.createForOfIteratorHelperLoose(childValues), _step3; !(_step3 = _iterator3()).done;) {
-    var value = _step3.value;
-
-    if (value != null) {
-      if (min === undefined) {
-        if (value >= value) min = max = value;
-      } else {
-        if (min > value) min = value;
-        if (max < value) max = value;
-      }
-    }
-  }
-
-  return [min, max];
-}
-
-function mean(leafValues) {
-  var count = 0;
-  var sum = 0;
-
-  for (var _iterator4 = _rollupPluginBabelHelpers.createForOfIteratorHelperLoose(leafValues), _step4; !(_step4 = _iterator4()).done;) {
-    var value = _step4.value;
-
-    if (value != null && (value = +value) >= value) {
-      ++count, sum += value;
-    }
-  }
-
-  if (count) return sum / count;
-  return;
-}
-
-function median(values) {
-  if (!values.length) {
-    return;
-  }
-
-  var min = 0;
-  var max = 0;
-  values.forEach(function (value) {
-    if (typeof value === 'number') {
-      min = Math.min(min, value);
-      max = Math.max(max, value);
-    }
-  });
-  return (min + max) / 2;
-}
-
-function unique(values) {
-  return Array.from(new Set(values).values());
-}
-
-function uniqueCount(values) {
-  return new Set(values).size;
-}
-
-function count(values) {
-  return values.length;
-}
-
-exports.aggregationTypes = aggregationTypes;
-//# sourceMappingURL=aggregationTypes.js.map

package/build/cjs/aggregationTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"aggregationTypes.js","sources":["../../src/aggregationTypes.ts"],"sourcesContent":["export const aggregationTypes = {\n  sum,\n  min,\n  max,\n  extent,\n  mean,\n  median,\n  unique,\n  uniqueCount,\n  count,\n}\n\nexport type BuiltInAggregationType = keyof typeof aggregationTypes\n\nfunction sum(_leafValues: unknown[], childValues: unknown[]) {\n  // It's faster to just add the aggregations together instead of\n  // process leaf nodes individually\n  return childValues.reduce(\n    (sum: number, next: unknown) => sum + (typeof next === 'number' ? next : 0),\n    0\n  )\n}\n\nfunction min(_leafValues: unknown[], childValues: unknown[]) {\n  let min: number | undefined\n\n  for (const value of childValues as number[]) {\n    if (\n      value != null &&\n      (min! > value || (min === undefined && value >= value))\n    ) {\n      min = value\n    }\n  }\n\n  return min\n}\n\nfunction max(_leafValues: unknown[], childValues: unknown[]) {\n  let max: number | undefined\n\n  for (const value of childValues as number[]) {\n    if (\n      value != null &&\n      (max! < value || (max === undefined && value >= value))\n    ) {\n      max = value\n    }\n  }\n\n  return max\n}\n\nfunction extent(_leafValues: unknown[], childValues: unknown[]) {\n  let min: number | undefined\n  let max: number | undefined\n\n  for (const value of childValues as number[]) {\n    if (value != null) {\n      if (min === undefined) {\n        if (value >= value) min = max = value\n      } else {\n        if (min > value) min = value\n        if (max! < value) max = value\n      }\n    }\n  }\n\n  return [min, max]\n}\n\nfunction mean(leafValues: unknown[]) {\n  let count = 0\n  let sum = 0\n\n  for (let value of leafValues as number[]) {\n    if (value != null && (value = +value) >= value) {\n      ++count, (sum += value)\n    }\n  }\n\n  if (count) return sum / count\n\n  return\n}\n\nfunction median(values: unknown[]) {\n  if (!values.length) {\n    return\n  }\n\n  let min = 0\n  let max = 0\n\n  values.forEach(value => {\n    if (typeof value === 'number') {\n      min = Math.min(min, value)\n      max = Math.max(max, value)\n    }\n  })\n\n  return (min + max) / 2\n}\n\nfunction unique<T>(values: T[]) {\n  return Array.from(new Set(values).values())\n}\n\nfunction uniqueCount(values: unknown[]) {\n  return new Set(values).size\n}\n\nfunction count(values: unknown[]) {\n  return values.length\n}\n"],"names":["aggregationTypes","sum","min","max","extent","mean","median","unique","uniqueCount","count","_leafValues","childValues","reduce","next","value","undefined","leafValues","values","length","forEach","Math","Array","from","Set","size"],"mappings":";;;;;;;;;;;;;;;;IAAaA,gBAAgB,GAAG;AAC9BC,EAAAA,GAAG,EAAHA,GAD8B;AAE9BC,EAAAA,GAAG,EAAHA,GAF8B;AAG9BC,EAAAA,GAAG,EAAHA,GAH8B;AAI9BC,EAAAA,MAAM,EAANA,MAJ8B;AAK9BC,EAAAA,IAAI,EAAJA,IAL8B;AAM9BC,EAAAA,MAAM,EAANA,MAN8B;AAO9BC,EAAAA,MAAM,EAANA,MAP8B;AAQ9BC,EAAAA,WAAW,EAAXA,WAR8B;AAS9BC,EAAAA,KAAK,EAALA;AAT8B;;AAchC,SAASR,GAAT,CAAaS,WAAb,EAAqCC,WAArC,EAA6D;AAC3D;AACA;AACA,SAAOA,WAAW,CAACC,MAAZ,CACL,UAACX,GAAD,EAAcY,IAAd;AAAA,WAAgCZ,GAAG,IAAI,OAAOY,IAAP,KAAgB,QAAhB,GAA2BA,IAA3B,GAAkC,CAAtC,CAAnC;AAAA,GADK,EAEL,CAFK,CAAP;AAID;;AAED,SAASX,GAAT,CAAaQ,WAAb,EAAqCC,WAArC,EAA6D;AAC3D,MAAIT,GAAJ;;AAEA,gFAAoBS,WAApB,wCAA6C;AAAA,QAAlCG,KAAkC;;AAC3C,QACEA,KAAK,IAAI,IAAT,KACCZ,GAAG,GAAIY,KAAP,IAAiBZ,GAAG,KAAKa,SAAR,IAAqBD,KAAK,IAAIA,KADhD,CADF,EAGE;AACAZ,MAAAA,GAAG,GAAGY,KAAN;AACD;AACF;;AAED,SAAOZ,GAAP;AACD;;AAED,SAASC,GAAT,CAAaO,WAAb,EAAqCC,WAArC,EAA6D;AAC3D,MAAIR,GAAJ;;AAEA,iFAAoBQ,WAApB,2CAA6C;AAAA,QAAlCG,KAAkC;;AAC3C,QACEA,KAAK,IAAI,IAAT,KACCX,GAAG,GAAIW,KAAP,IAAiBX,GAAG,KAAKY,SAAR,IAAqBD,KAAK,IAAIA,KADhD,CADF,EAGE;AACAX,MAAAA,GAAG,GAAGW,KAAN;AACD;AACF;;AAED,SAAOX,GAAP;AACD;;AAED,SAASC,MAAT,CAAgBM,WAAhB,EAAwCC,WAAxC,EAAgE;AAC9D,MAAIT,GAAJ;AACA,MAAIC,GAAJ;;AAEA,iFAAoBQ,WAApB,2CAA6C;AAAA,QAAlCG,KAAkC;;AAC3C,QAAIA,KAAK,IAAI,IAAb,EAAmB;AACjB,UAAIZ,GAAG,KAAKa,SAAZ,EAAuB;AACrB,YAAID,KAAK,IAAIA,KAAb,EAAoBZ,GAAG,GAAGC,GAAG,GAAGW,KAAZ;AACrB,OAFD,MAEO;AACL,YAAIZ,GAAG,GAAGY,KAAV,EAAiBZ,GAAG,GAAGY,KAAN;AACjB,YAAIX,GAAG,GAAIW,KAAX,EAAkBX,GAAG,GAAGW,KAAN;AACnB;AACF;AACF;;AAED,SAAO,CAACZ,GAAD,EAAMC,GAAN,CAAP;AACD;;AAED,SAASE,IAAT,CAAcW,UAAd,EAAqC;AACnC,MAAIP,KAAK,GAAG,CAAZ;AACA,MAAIR,GAAG,GAAG,CAAV;;AAEA,iFAAkBe,UAAlB,2CAA0C;AAAA,QAAjCF,KAAiC;;AACxC,QAAIA,KAAK,IAAI,IAAT,IAAiB,CAACA,KAAK,GAAG,CAACA,KAAV,KAAoBA,KAAzC,EAAgD;AAC9C,QAAEL,KAAF,EAAUR,GAAG,IAAIa,KAAjB;AACD;AACF;;AAED,MAAIL,KAAJ,EAAW,OAAOR,GAAG,GAAGQ,KAAb;AAEX;AACD;;AAED,SAASH,MAAT,CAAgBW,MAAhB,EAAmC;AACjC,MAAI,CAACA,MAAM,CAACC,MAAZ,EAAoB;AAClB;AACD;;AAED,MAAIhB,GAAG,GAAG,CAAV;AACA,MAAIC,GAAG,GAAG,CAAV;AAEAc,EAAAA,MAAM,CAACE,OAAP,CAAe,UAAAL,KAAK,EAAI;AACtB,QAAI,OAAOA,KAAP,KAAiB,QAArB,EAA+B;AAC7BZ,MAAAA,GAAG,GAAGkB,IAAI,CAAClB,GAAL,CAASA,GAAT,EAAcY,KAAd,CAAN;AACAX,MAAAA,GAAG,GAAGiB,IAAI,CAACjB,GAAL,CAASA,GAAT,EAAcW,KAAd,CAAN;AACD;AACF,GALD;AAOA,SAAO,CAACZ,GAAG,GAAGC,GAAP,IAAc,CAArB;AACD;;AAED,SAASI,MAAT,CAAmBU,MAAnB,EAAgC;AAC9B,SAAOI,KAAK,CAACC,IAAN,CAAW,IAAIC,GAAJ,CAAQN,MAAR,EAAgBA,MAAhB,EAAX,CAAP;AACD;;AAED,SAAST,WAAT,CAAqBS,MAArB,EAAwC;AACtC,SAAO,IAAIM,GAAJ,CAAQN,MAAR,EAAgBO,IAAvB;AACD;;AAED,SAASf,KAAT,CAAeQ,MAAf,EAAkC;AAChC,SAAOA,MAAM,CAACC,MAAd;AACD;;;;"}