@hitachivantara/uikit-react-lab 3.38.0

package/dist/modern/Table/hooks/useSticky.d.ts

@@ -0,0 +1,47 @@
+import { Hooks, PropGetter, TableCommonProps } from "react-table";
+
+export interface UseHvTableStickyTableHeadProps extends TableCommonProps {
+  stickyHeader?: boolean;
+}
+
+export type HvTableHeadPropGetter<D extends object> = PropGetter<D, UseHvTableStickyTableHeadProps>;
+
+export type UseHvTableStickyTableOptions = {
+  stickyHeader?: boolean;
+  stickyColumns?: boolean;
+};
+
+export interface UseHvTableStickyHooks<D extends object> {
+  getTableHeadProps: Array<HvTableHeadPropGetter<D>>;
+}
+
+export interface UseHvTableStickyTableInstance<D extends object> {
+  getTableHeadProps: (propGetter?: HvTableHeadPropGetter<D>) => UseHvTableStickyTableHeadProps;
+
+  totalRight?: number;
+  hasStickyColumns?: boolean;
+}
+
+// props target: <table>
+export interface UseHvTableStickyTableProps {
+  stickyHeader?: boolean;
+  stickyColumns?: boolean;
+}
+
+// props target: <table><thead><tr><th>
+export interface UseHvTableStickyColumnProps {
+  stickyColumn?: boolean;
+  stickyColumnMostLeft?: boolean;
+  stickyColumnLeastRight?: boolean;
+}
+
+// props target: <table><tbody><tr><td>
+export interface UseHvTableStickyCellProps {
+  stickyColumn?: boolean;
+  stickyColumnMostLeft?: boolean;
+  stickyColumnLeastRight?: boolean;
+}
+
+export default function useHvTableSticky<D extends object = Record<string, unknown>>(
+  hooks: Hooks<D>
+): void;

package/dist/modern/Table/hooks/useSticky.js

@@ -0,0 +1,267 @@
+import "core-js/modules/web.dom-collections.iterator.js";
+
+/* eslint-disable no-param-reassign */
+import { makePropGetter, useGetLatest } from "react-table";
+
+const isSticky = value => /left|right/i.test(value);
+
+const getStickyValue = ({
+  sticky,
+  parent
+}) => {
+  if (isSticky(sticky)) {
+    return sticky;
+  }
+
+  if (parent != null) {
+    // check if parent is sticky
+    sticky = getStickyValue(parent);
+
+    if (isSticky(sticky)) {
+      return sticky;
+    }
+
+    const {
+      columns
+    } = parent; // check if any column in the same group is sticky
+
+    if ((columns === null || columns === void 0 ? void 0 : columns.length) > 0) {
+      var _columns$find;
+
+      sticky = columns === null || columns === void 0 ? void 0 : (_columns$find = columns.find(col => col.sticky != null)) === null || _columns$find === void 0 ? void 0 : _columns$find.sticky;
+
+      if (isSticky(sticky)) {
+        return sticky;
+      }
+    }
+  }
+
+  return undefined;
+};
+
+const updateColumnAndParent = (column, props) => {
+  Object.assign(column, props);
+
+  if (column.parent != null) {
+    updateColumnAndParent(column.parent, props);
+  }
+};
+
+export const visibleColumnsHook = (columns, {
+  instance
+}) => {
+  const toTheLeft = [];
+  const toTheRight = [];
+  const others = [];
+  columns.forEach(column => {
+    var _getStickyValue;
+
+    const sticky = (_getStickyValue = getStickyValue(column)) === null || _getStickyValue === void 0 ? void 0 : _getStickyValue.toLowerCase();
+    updateColumnAndParent(column, {
+      sticky
+    });
+
+    if (sticky === "left") {
+      toTheLeft.push(column);
+    } else if (sticky === "right") {
+      toTheRight.push(column);
+    } else {
+      others.push(column);
+    }
+  });
+
+  if (others.length > 0) {
+    const [firstNotSticky] = others;
+    updateColumnAndParent(firstNotSticky, {
+      isFirstNotSticky: true
+    });
+    const lastNotSticky = others[others.length - 1];
+    updateColumnAndParent(lastNotSticky, {
+      isLastNotSticky: true
+    });
+  }
+
+  const hasLeftSticky = toTheLeft.length > 0;
+
+  if (hasLeftSticky) {
+    const lastLeftSticky = toTheLeft[toTheLeft.length - 1];
+    updateColumnAndParent(lastLeftSticky, {
+      isLastLeftSticky: true
+    });
+  }
+
+  const hasRightSticky = toTheRight.length > 0;
+
+  if (hasRightSticky) {
+    const [firstRightSticky] = toTheRight;
+    updateColumnAndParent(firstRightSticky, {
+      isFirstRightSticky: true
+    });
+  }
+
+  instance.hasStickyColumns = hasLeftSticky || hasRightSticky;
+  return [...toTheLeft, ...others, ...toTheRight];
+};
+
+const calculateHeaderWidthsToTheRight = (headers, right = 0) => {
+  if (!(headers !== null && headers !== void 0 && headers.length)) {
+    return;
+  }
+
+  for (let i = headers.length - 1; i !== -1; i -= 1) {
+    const header = headers[i];
+    header.totalRight = right;
+    const {
+      headers: subHeaders
+    } = header;
+
+    if ((subHeaders === null || subHeaders === void 0 ? void 0 : subHeaders.length) > 0) {
+      calculateHeaderWidthsToTheRight(subHeaders, right);
+    }
+
+    if (header.isVisible) {
+      right += header.totalWidth;
+    }
+  }
+};
+
+export const useInstanceHook = instance => {
+  calculateHeaderWidthsToTheRight(instance.headers);
+  const getInstance = useGetLatest(instance);
+  instance.getTableHeadProps = makePropGetter(instance.getHooks().getTableHeadProps, {
+    instance: getInstance()
+  });
+};
+
+const getRowProps = () => ({
+  style: {
+    display: "flex",
+    flex: "1 0 auto"
+  }
+});
+
+const getCellProps = (header, isHeaderCell) => {
+  const props = {
+    style: {
+      display: "inline-flex",
+      flex: `${header.totalWidth} ${header.totalMinWidth} auto`,
+      alignItems: isHeaderCell ? "start" : "center",
+      justifyContent: header.align,
+      width: `${header.totalWidth}px`,
+      minWidth: `${header.totalMinWidth}px`
+    }
+  };
+
+  if (header.sticky != null) {
+    props.stickyColumn = true;
+    const margin = header.sticky === "left" ? header.totalLeft : header.totalRight;
+    props.style[header.sticky] = `${margin}px`;
+
+    if (header.isLastLeftSticky) {
+      props.stickyColumnMostLeft = true;
+    }
+
+    if (header.isFirstRightSticky) {
+      props.stickyColumnLeastRight = true;
+    }
+  } else {
+    if (header.isFirstNotSticky) {
+      props.style.borderLeft = 0;
+    }
+
+    if (header.isLastNotSticky) {
+      props.style.borderRight = 0;
+    }
+  }
+
+  return props;
+};
+/*
+ * STICKY POSITION MANAGEMENT
+ *   <thead>: sticky if stickyHeader: true
+ *   <tr>: never sticky
+ *   <th>: sticky only if that particular column is sticky (left or right)
+ */
+
+/*
+ * We need to hide the last non sticky column right border, to avoid issues with double borders.
+ *
+ * This could be done with css, using the `:has()` selector:
+ *  - ".not-sticky:has(+ .first-right-sticky)": { border-right: 0 }
+ *
+ * Until the `:has()` selector is supported by modern browsers,
+ * that at the moment is just a proposal https://developer.mozilla.org/en-US/docs/Web/CSS/:has,
+ * we need to override the last not sticky column "borderRight" here.
+ */
+// props target: <table>
+
+
+export const getTablePropsHook = (props, {
+  instance
+}) => {
+  const nextProps = {
+    stickyHeader: instance.stickyHeader,
+    stickyColumns: instance.hasStickyColumns
+  };
+  return [props, nextProps];
+}; // props target: <table><thead>
+
+export const getTableHeadPropsHook = (props, {
+  instance
+}) => {
+  const nextProps = {
+    stickyHeader: instance.stickyHeader
+  };
+  return [props, nextProps];
+}; // props target: <table><thead><tr>
+
+export const getHeaderGroupPropsHook = (props, {
+  instance
+}) => {
+  const nextProps = instance.hasStickyColumns ? getRowProps() : {};
+  return [props, nextProps];
+}; // props target: <table><thead><tr><th>
+
+export const getHeaderPropsHook = (props, {
+  instance,
+  column
+}) => {
+  const nextProps = instance.hasStickyColumns ? getCellProps(column, true) : {};
+  return [props, nextProps];
+}; // props target: <table><tbody><tr>
+
+export const getRowPropsHook = (props, {
+  instance
+}) => {
+  const nextProps = instance.hasStickyColumns ? getRowProps() : {};
+  return [props, nextProps];
+}; // props target: <table><tbody><tr><td>
+
+export const getCellPropsHook = (props, {
+  instance,
+  cell
+}) => {
+  const nextProps = instance.hasStickyColumns ? getCellProps(cell.column, false) : {};
+  return [props, nextProps];
+};
+
+const useSticky = hooks => {
+  hooks.visibleColumns.push(visibleColumnsHook);
+  hooks.useInstance.push(useInstanceHook); // props target: <table>
+
+  hooks.getTableProps.push(getTablePropsHook); // props target: <table><thead>
+
+  hooks.getTableHeadProps = [getTableHeadPropsHook]; // props target: <table><thead><tr>
+
+  hooks.getHeaderGroupProps.push(getHeaderGroupPropsHook); // props target: <table><thead><tr><th>
+
+  hooks.getHeaderProps.push(getHeaderPropsHook); // props target: <table><tbody><tr>
+
+  hooks.getRowProps.push(getRowPropsHook); // props target: <table><tbody><tr><td>
+
+  hooks.getCellProps.push(getCellPropsHook);
+};
+
+useSticky.pluginName = "useHvTableSticky";
+export default useSticky;
+//# sourceMappingURL=useSticky.js.map

package/dist/modern/Table/hooks/useSticky.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/Table/hooks/useSticky.js"],"names":["makePropGetter","useGetLatest","isSticky","value","test","getStickyValue","sticky","parent","columns","length","find","col","undefined","updateColumnAndParent","column","props","Object","assign","visibleColumnsHook","instance","toTheLeft","toTheRight","others","forEach","toLowerCase","push","firstNotSticky","isFirstNotSticky","lastNotSticky","isLastNotSticky","hasLeftSticky","lastLeftSticky","isLastLeftSticky","hasRightSticky","firstRightSticky","isFirstRightSticky","hasStickyColumns","calculateHeaderWidthsToTheRight","headers","right","i","header","totalRight","subHeaders","isVisible","totalWidth","useInstanceHook","getInstance","getTableHeadProps","getHooks","getRowProps","style","display","flex","getCellProps","isHeaderCell","totalMinWidth","alignItems","justifyContent","align","width","minWidth","stickyColumn","margin","totalLeft","stickyColumnMostLeft","stickyColumnLeastRight","borderLeft","borderRight","getTablePropsHook","nextProps","stickyHeader","stickyColumns","getTableHeadPropsHook","getHeaderGroupPropsHook","getHeaderPropsHook","getRowPropsHook","getCellPropsHook","cell","useSticky","hooks","visibleColumns","useInstance","getTableProps","getHeaderGroupProps","getHeaderProps","pluginName"],"mappings":";;AAAA;AAEA,SAASA,cAAT,EAAyBC,YAAzB,QAA6C,aAA7C;;AAEA,MAAMC,QAAQ,GAAIC,KAAD,IAAW,cAAcC,IAAd,CAAmBD,KAAnB,CAA5B;;AAEA,MAAME,cAAc,GAAG,CAAC;AAAEC,EAAAA,MAAF;AAAUC,EAAAA;AAAV,CAAD,KAAwB;AAC7C,MAAIL,QAAQ,CAACI,MAAD,CAAZ,EAAsB;AACpB,WAAOA,MAAP;AACD;;AAED,MAAIC,MAAM,IAAI,IAAd,EAAoB;AAClB;AACAD,IAAAA,MAAM,GAAGD,cAAc,CAACE,MAAD,CAAvB;;AACA,QAAIL,QAAQ,CAACI,MAAD,CAAZ,EAAsB;AACpB,aAAOA,MAAP;AACD;;AAED,UAAM;AAAEE,MAAAA;AAAF,QAAcD,MAApB,CAPkB,CAQlB;;AACA,QAAI,CAAAC,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEC,MAAT,IAAkB,CAAtB,EAAyB;AAAA;;AACvBH,MAAAA,MAAM,GAAGE,OAAH,aAAGA,OAAH,wCAAGA,OAAO,CAAEE,IAAT,CAAeC,GAAD,IAASA,GAAG,CAACL,MAAJ,IAAc,IAArC,CAAH,kDAAG,cAA4CA,MAArD;;AACA,UAAIJ,QAAQ,CAACI,MAAD,CAAZ,EAAsB;AACpB,eAAOA,MAAP;AACD;AACF;AACF;;AAED,SAAOM,SAAP;AACD,CAvBD;;AAyBA,MAAMC,qBAAqB,GAAG,CAACC,MAAD,EAASC,KAAT,KAAmB;AAC/CC,EAAAA,MAAM,CAACC,MAAP,CAAcH,MAAd,EAAsBC,KAAtB;;AAEA,MAAID,MAAM,CAACP,MAAP,IAAiB,IAArB,EAA2B;AACzBM,IAAAA,qBAAqB,CAACC,MAAM,CAACP,MAAR,EAAgBQ,KAAhB,CAArB;AACD;AACF,CAND;;AAQA,OAAO,MAAMG,kBAAkB,GAAG,CAACV,OAAD,EAAU;AAAEW,EAAAA;AAAF,CAAV,KAA2B;AAC3D,QAAMC,SAAS,GAAG,EAAlB;AACA,QAAMC,UAAU,GAAG,EAAnB;AACA,QAAMC,MAAM,GAAG,EAAf;AAEAd,EAAAA,OAAO,CAACe,OAAR,CAAiBT,MAAD,IAAY;AAAA;;AAC1B,UAAMR,MAAM,sBAAGD,cAAc,CAACS,MAAD,CAAjB,oDAAG,gBAAwBU,WAAxB,EAAf;AAEAX,IAAAA,qBAAqB,CAACC,MAAD,EAAS;AAAER,MAAAA;AAAF,KAAT,CAArB;;AAEA,QAAIA,MAAM,KAAK,MAAf,EAAuB;AACrBc,MAAAA,SAAS,CAACK,IAAV,CAAeX,MAAf;AACD,KAFD,MAEO,IAAIR,MAAM,KAAK,OAAf,EAAwB;AAC7Be,MAAAA,UAAU,CAACI,IAAX,CAAgBX,MAAhB;AACD,KAFM,MAEA;AACLQ,MAAAA,MAAM,CAACG,IAAP,CAAYX,MAAZ;AACD;AACF,GAZD;;AAcA,MAAIQ,MAAM,CAACb,MAAP,GAAgB,CAApB,EAAuB;AACrB,UAAM,CAACiB,cAAD,IAAmBJ,MAAzB;AACAT,IAAAA,qBAAqB,CAACa,cAAD,EAAiB;AAAEC,MAAAA,gBAAgB,EAAE;AAApB,KAAjB,CAArB;AAEA,UAAMC,aAAa,GAAGN,MAAM,CAACA,MAAM,CAACb,MAAP,GAAgB,CAAjB,CAA5B;AACAI,IAAAA,qBAAqB,CAACe,aAAD,EAAgB;AAAEC,MAAAA,eAAe,EAAE;AAAnB,KAAhB,CAArB;AACD;;AAED,QAAMC,aAAa,GAAGV,SAAS,CAACX,MAAV,GAAmB,CAAzC;;AACA,MAAIqB,aAAJ,EAAmB;AACjB,UAAMC,cAAc,GAAGX,SAAS,CAACA,SAAS,CAACX,MAAV,GAAmB,CAApB,CAAhC;AAEAI,IAAAA,qBAAqB,CAACkB,cAAD,EAAiB;AAAEC,MAAAA,gBAAgB,EAAE;AAApB,KAAjB,CAArB;AACD;;AAED,QAAMC,cAAc,GAAGZ,UAAU,CAACZ,MAAX,GAAoB,CAA3C;;AACA,MAAIwB,cAAJ,EAAoB;AAClB,UAAM,CAACC,gBAAD,IAAqBb,UAA3B;AAEAR,IAAAA,qBAAqB,CAACqB,gBAAD,EAAmB;AAAEC,MAAAA,kBAAkB,EAAE;AAAtB,KAAnB,CAArB;AACD;;AAEDhB,EAAAA,QAAQ,CAACiB,gBAAT,GAA4BN,aAAa,IAAIG,cAA7C;AAEA,SAAO,CAAC,GAAGb,SAAJ,EAAe,GAAGE,MAAlB,EAA0B,GAAGD,UAA7B,CAAP;AACD,CA5CM;;AA8CP,MAAMgB,+BAA+B,GAAG,CAACC,OAAD,EAAUC,KAAK,GAAG,CAAlB,KAAwB;AAC9D,MAAI,EAACD,OAAD,aAACA,OAAD,eAACA,OAAO,CAAE7B,MAAV,CAAJ,EAAsB;AACpB;AACD;;AAED,OAAK,IAAI+B,CAAC,GAAGF,OAAO,CAAC7B,MAAR,GAAiB,CAA9B,EAAiC+B,CAAC,KAAK,CAAC,CAAxC,EAA2CA,CAAC,IAAI,CAAhD,EAAmD;AACjD,UAAMC,MAAM,GAAGH,OAAO,CAACE,CAAD,CAAtB;AAEAC,IAAAA,MAAM,CAACC,UAAP,GAAoBH,KAApB;AAEA,UAAM;AAAED,MAAAA,OAAO,EAAEK;AAAX,QAA0BF,MAAhC;;AACA,QAAI,CAAAE,UAAU,SAAV,IAAAA,UAAU,WAAV,YAAAA,UAAU,CAAElC,MAAZ,IAAqB,CAAzB,EAA4B;AAC1B4B,MAAAA,+BAA+B,CAACM,UAAD,EAAaJ,KAAb,CAA/B;AACD;;AAED,QAAIE,MAAM,CAACG,SAAX,EAAsB;AACpBL,MAAAA,KAAK,IAAIE,MAAM,CAACI,UAAhB;AACD;AACF;AACF,CAnBD;;AAqBA,OAAO,MAAMC,eAAe,GAAI3B,QAAD,IAAc;AAC3CkB,EAAAA,+BAA+B,CAAClB,QAAQ,CAACmB,OAAV,CAA/B;AAEA,QAAMS,WAAW,GAAG9C,YAAY,CAACkB,QAAD,CAAhC;AACAA,EAAAA,QAAQ,CAAC6B,iBAAT,GAA6BhD,cAAc,CAACmB,QAAQ,CAAC8B,QAAT,GAAoBD,iBAArB,EAAwC;AACjF7B,IAAAA,QAAQ,EAAE4B,WAAW;AAD4D,GAAxC,CAA3C;AAGD,CAPM;;AASP,MAAMG,WAAW,GAAG,OAAO;AACzBC,EAAAA,KAAK,EAAE;AACLC,IAAAA,OAAO,EAAE,MADJ;AAELC,IAAAA,IAAI,EAAE;AAFD;AADkB,CAAP,CAApB;;AAOA,MAAMC,YAAY,GAAG,CAACb,MAAD,EAASc,YAAT,KAA0B;AAC7C,QAAMxC,KAAK,GAAG;AACZoC,IAAAA,KAAK,EAAE;AACLC,MAAAA,OAAO,EAAE,aADJ;AAELC,MAAAA,IAAI,EAAG,GAAEZ,MAAM,CAACI,UAAW,IAAGJ,MAAM,CAACe,aAAc,OAF9C;AAGLC,MAAAA,UAAU,EAAEF,YAAY,GAAG,OAAH,GAAa,QAHhC;AAILG,MAAAA,cAAc,EAAEjB,MAAM,CAACkB,KAJlB;AAMLC,MAAAA,KAAK,EAAG,GAAEnB,MAAM,CAACI,UAAW,IANvB;AAOLgB,MAAAA,QAAQ,EAAG,GAAEpB,MAAM,CAACe,aAAc;AAP7B;AADK,GAAd;;AAYA,MAAIf,MAAM,CAACnC,MAAP,IAAiB,IAArB,EAA2B;AACzBS,IAAAA,KAAK,CAAC+C,YAAN,GAAqB,IAArB;AAEA,UAAMC,MAAM,GAAGtB,MAAM,CAACnC,MAAP,KAAkB,MAAlB,GAA2BmC,MAAM,CAACuB,SAAlC,GAA8CvB,MAAM,CAACC,UAApE;AAEA3B,IAAAA,KAAK,CAACoC,KAAN,CAAYV,MAAM,CAACnC,MAAnB,IAA8B,GAAEyD,MAAO,IAAvC;;AAEA,QAAItB,MAAM,CAACT,gBAAX,EAA6B;AAC3BjB,MAAAA,KAAK,CAACkD,oBAAN,GAA6B,IAA7B;AACD;;AAED,QAAIxB,MAAM,CAACN,kBAAX,EAA+B;AAC7BpB,MAAAA,KAAK,CAACmD,sBAAN,GAA+B,IAA/B;AACD;AACF,GAdD,MAcO;AACL,QAAIzB,MAAM,CAACd,gBAAX,EAA6B;AAC3BZ,MAAAA,KAAK,CAACoC,KAAN,CAAYgB,UAAZ,GAAyB,CAAzB;AACD;;AAED,QAAI1B,MAAM,CAACZ,eAAX,EAA4B;AAC1Bd,MAAAA,KAAK,CAACoC,KAAN,CAAYiB,WAAZ,GAA0B,CAA1B;AACD;AACF;;AAED,SAAOrD,KAAP;AACD,CAtCD;AAwCA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;;;AACA,OAAO,MAAMsD,iBAAiB,GAAG,CAACtD,KAAD,EAAQ;AAAEI,EAAAA;AAAF,CAAR,KAAyB;AACxD,QAAMmD,SAAS,GAAG;AAChBC,IAAAA,YAAY,EAAEpD,QAAQ,CAACoD,YADP;AAEhBC,IAAAA,aAAa,EAAErD,QAAQ,CAACiB;AAFR,GAAlB;AAKA,SAAO,CAACrB,KAAD,EAAQuD,SAAR,CAAP;AACD,CAPM,C,CASP;;AACA,OAAO,MAAMG,qBAAqB,GAAG,CAAC1D,KAAD,EAAQ;AAAEI,EAAAA;AAAF,CAAR,KAAyB;AAC5D,QAAMmD,SAAS,GAAG;AAChBC,IAAAA,YAAY,EAAEpD,QAAQ,CAACoD;AADP,GAAlB;AAIA,SAAO,CAACxD,KAAD,EAAQuD,SAAR,CAAP;AACD,CANM,C,CAQP;;AACA,OAAO,MAAMI,uBAAuB,GAAG,CAAC3D,KAAD,EAAQ;AAAEI,EAAAA;AAAF,CAAR,KAAyB;AAC9D,QAAMmD,SAAS,GAAGnD,QAAQ,CAACiB,gBAAT,GAA4Bc,WAAW,EAAvC,GAA4C,EAA9D;AAEA,SAAO,CAACnC,KAAD,EAAQuD,SAAR,CAAP;AACD,CAJM,C,CAMP;;AACA,OAAO,MAAMK,kBAAkB,GAAG,CAAC5D,KAAD,EAAQ;AAAEI,EAAAA,QAAF;AAAYL,EAAAA;AAAZ,CAAR,KAAiC;AACjE,QAAMwD,SAAS,GAAGnD,QAAQ,CAACiB,gBAAT,GAA4BkB,YAAY,CAACxC,MAAD,EAAS,IAAT,CAAxC,GAAyD,EAA3E;AAEA,SAAO,CAACC,KAAD,EAAQuD,SAAR,CAAP;AACD,CAJM,C,CAMP;;AACA,OAAO,MAAMM,eAAe,GAAG,CAAC7D,KAAD,EAAQ;AAAEI,EAAAA;AAAF,CAAR,KAAyB;AACtD,QAAMmD,SAAS,GAAGnD,QAAQ,CAACiB,gBAAT,GAA4Bc,WAAW,EAAvC,GAA4C,EAA9D;AAEA,SAAO,CAACnC,KAAD,EAAQuD,SAAR,CAAP;AACD,CAJM,C,CAMP;;AACA,OAAO,MAAMO,gBAAgB,GAAG,CAAC9D,KAAD,EAAQ;AAAEI,EAAAA,QAAF;AAAY2D,EAAAA;AAAZ,CAAR,KAA+B;AAC7D,QAAMR,SAAS,GAAGnD,QAAQ,CAACiB,gBAAT,GAA4BkB,YAAY,CAACwB,IAAI,CAAChE,MAAN,EAAc,KAAd,CAAxC,GAA+D,EAAjF;AAEA,SAAO,CAACC,KAAD,EAAQuD,SAAR,CAAP;AACD,CAJM;;AAMP,MAAMS,SAAS,GAAIC,KAAD,IAAW;AAC3BA,EAAAA,KAAK,CAACC,cAAN,CAAqBxD,IAArB,CAA0BP,kBAA1B;AACA8D,EAAAA,KAAK,CAACE,WAAN,CAAkBzD,IAAlB,CAAuBqB,eAAvB,EAF2B,CAI3B;;AACAkC,EAAAA,KAAK,CAACG,aAAN,CAAoB1D,IAApB,CAAyB4C,iBAAzB,EAL2B,CAM3B;;AACAW,EAAAA,KAAK,CAAChC,iBAAN,GAA0B,CAACyB,qBAAD,CAA1B,CAP2B,CAQ3B;;AACAO,EAAAA,KAAK,CAACI,mBAAN,CAA0B3D,IAA1B,CAA+BiD,uBAA/B,EAT2B,CAU3B;;AACAM,EAAAA,KAAK,CAACK,cAAN,CAAqB5D,IAArB,CAA0BkD,kBAA1B,EAX2B,CAY3B;;AACAK,EAAAA,KAAK,CAAC9B,WAAN,CAAkBzB,IAAlB,CAAuBmD,eAAvB,EAb2B,CAc3B;;AACAI,EAAAA,KAAK,CAAC1B,YAAN,CAAmB7B,IAAnB,CAAwBoD,gBAAxB;AACD,CAhBD;;AAkBAE,SAAS,CAACO,UAAV,GAAuB,kBAAvB;AAEA,eAAeP,SAAf","sourcesContent":["/* eslint-disable no-param-reassign */\n\nimport { makePropGetter, useGetLatest } from \"react-table\";\n\nconst isSticky = (value) => /left|right/i.test(value);\n\nconst getStickyValue = ({ sticky, parent }) => {\n  if (isSticky(sticky)) {\n    return sticky;\n  }\n\n  if (parent != null) {\n    // check if parent is sticky\n    sticky = getStickyValue(parent);\n    if (isSticky(sticky)) {\n      return sticky;\n    }\n\n    const { columns } = parent;\n    // check if any column in the same group is sticky\n    if (columns?.length > 0) {\n      sticky = columns?.find((col) => col.sticky != null)?.sticky;\n      if (isSticky(sticky)) {\n        return sticky;\n      }\n    }\n  }\n\n  return undefined;\n};\n\nconst updateColumnAndParent = (column, props) => {\n  Object.assign(column, props);\n\n  if (column.parent != null) {\n    updateColumnAndParent(column.parent, props);\n  }\n};\n\nexport const visibleColumnsHook = (columns, { instance }) => {\n  const toTheLeft = [];\n  const toTheRight = [];\n  const others = [];\n\n  columns.forEach((column) => {\n    const sticky = getStickyValue(column)?.toLowerCase();\n\n    updateColumnAndParent(column, { sticky });\n\n    if (sticky === \"left\") {\n      toTheLeft.push(column);\n    } else if (sticky === \"right\") {\n      toTheRight.push(column);\n    } else {\n      others.push(column);\n    }\n  });\n\n  if (others.length > 0) {\n    const [firstNotSticky] = others;\n    updateColumnAndParent(firstNotSticky, { isFirstNotSticky: true });\n\n    const lastNotSticky = others[others.length - 1];\n    updateColumnAndParent(lastNotSticky, { isLastNotSticky: true });\n  }\n\n  const hasLeftSticky = toTheLeft.length > 0;\n  if (hasLeftSticky) {\n    const lastLeftSticky = toTheLeft[toTheLeft.length - 1];\n\n    updateColumnAndParent(lastLeftSticky, { isLastLeftSticky: true });\n  }\n\n  const hasRightSticky = toTheRight.length > 0;\n  if (hasRightSticky) {\n    const [firstRightSticky] = toTheRight;\n\n    updateColumnAndParent(firstRightSticky, { isFirstRightSticky: true });\n  }\n\n  instance.hasStickyColumns = hasLeftSticky || hasRightSticky;\n\n  return [...toTheLeft, ...others, ...toTheRight];\n};\n\nconst calculateHeaderWidthsToTheRight = (headers, right = 0) => {\n  if (!headers?.length) {\n    return;\n  }\n\n  for (let i = headers.length - 1; i !== -1; i -= 1) {\n    const header = headers[i];\n\n    header.totalRight = right;\n\n    const { headers: subHeaders } = header;\n    if (subHeaders?.length > 0) {\n      calculateHeaderWidthsToTheRight(subHeaders, right);\n    }\n\n    if (header.isVisible) {\n      right += header.totalWidth;\n    }\n  }\n};\n\nexport const useInstanceHook = (instance) => {\n  calculateHeaderWidthsToTheRight(instance.headers);\n\n  const getInstance = useGetLatest(instance);\n  instance.getTableHeadProps = makePropGetter(instance.getHooks().getTableHeadProps, {\n    instance: getInstance(),\n  });\n};\n\nconst getRowProps = () => ({\n  style: {\n    display: \"flex\",\n    flex: \"1 0 auto\",\n  },\n});\n\nconst getCellProps = (header, isHeaderCell) => {\n  const props = {\n    style: {\n      display: \"inline-flex\",\n      flex: `${header.totalWidth} ${header.totalMinWidth} auto`,\n      alignItems: isHeaderCell ? \"start\" : \"center\",\n      justifyContent: header.align,\n\n      width: `${header.totalWidth}px`,\n      minWidth: `${header.totalMinWidth}px`,\n    },\n  };\n\n  if (header.sticky != null) {\n    props.stickyColumn = true;\n\n    const margin = header.sticky === \"left\" ? header.totalLeft : header.totalRight;\n\n    props.style[header.sticky] = `${margin}px`;\n\n    if (header.isLastLeftSticky) {\n      props.stickyColumnMostLeft = true;\n    }\n\n    if (header.isFirstRightSticky) {\n      props.stickyColumnLeastRight = true;\n    }\n  } else {\n    if (header.isFirstNotSticky) {\n      props.style.borderLeft = 0;\n    }\n\n    if (header.isLastNotSticky) {\n      props.style.borderRight = 0;\n    }\n  }\n\n  return props;\n};\n\n/*\n * STICKY POSITION MANAGEMENT\n *   <thead>: sticky if stickyHeader: true\n *   <tr>: never sticky\n *   <th>: sticky only if that particular column is sticky (left or right)\n */\n\n/*\n * We need to hide the last non sticky column right border, to avoid issues with double borders.\n *\n * This could be done with css, using the `:has()` selector:\n *  - \".not-sticky:has(+ .first-right-sticky)\": { border-right: 0 }\n *\n * Until the `:has()` selector is supported by modern browsers,\n * that at the moment is just a proposal https://developer.mozilla.org/en-US/docs/Web/CSS/:has,\n * we need to override the last not sticky column \"borderRight\" here.\n */\n\n// props target: <table>\nexport const getTablePropsHook = (props, { instance }) => {\n  const nextProps = {\n    stickyHeader: instance.stickyHeader,\n    stickyColumns: instance.hasStickyColumns,\n  };\n\n  return [props, nextProps];\n};\n\n// props target: <table><thead>\nexport const getTableHeadPropsHook = (props, { instance }) => {\n  const nextProps = {\n    stickyHeader: instance.stickyHeader,\n  };\n\n  return [props, nextProps];\n};\n\n// props target: <table><thead><tr>\nexport const getHeaderGroupPropsHook = (props, { instance }) => {\n  const nextProps = instance.hasStickyColumns ? getRowProps() : {};\n\n  return [props, nextProps];\n};\n\n// props target: <table><thead><tr><th>\nexport const getHeaderPropsHook = (props, { instance, column }) => {\n  const nextProps = instance.hasStickyColumns ? getCellProps(column, true) : {};\n\n  return [props, nextProps];\n};\n\n// props target: <table><tbody><tr>\nexport const getRowPropsHook = (props, { instance }) => {\n  const nextProps = instance.hasStickyColumns ? getRowProps() : {};\n\n  return [props, nextProps];\n};\n\n// props target: <table><tbody><tr><td>\nexport const getCellPropsHook = (props, { instance, cell }) => {\n  const nextProps = instance.hasStickyColumns ? getCellProps(cell.column, false) : {};\n\n  return [props, nextProps];\n};\n\nconst useSticky = (hooks) => {\n  hooks.visibleColumns.push(visibleColumnsHook);\n  hooks.useInstance.push(useInstanceHook);\n\n  // props target: <table>\n  hooks.getTableProps.push(getTablePropsHook);\n  // props target: <table><thead>\n  hooks.getTableHeadProps = [getTableHeadPropsHook];\n  // props target: <table><thead><tr>\n  hooks.getHeaderGroupProps.push(getHeaderGroupPropsHook);\n  // props target: <table><thead><tr><th>\n  hooks.getHeaderProps.push(getHeaderPropsHook);\n  // props target: <table><tbody><tr>\n  hooks.getRowProps.push(getRowPropsHook);\n  // props target: <table><tbody><tr><td>\n  hooks.getCellProps.push(getCellPropsHook);\n};\n\nuseSticky.pluginName = \"useHvTableSticky\";\n\nexport default useSticky;\n"],"file":"useSticky.js"}

package/dist/modern/Table/hooks/useTable.d.ts

@@ -0,0 +1,336 @@
+/* eslint-disable no-use-before-define */
+import {
+  Cell,
+  CellPropGetter,
+  CellProps,
+  ColumnInstance,
+  ColumnInterface,
+  FooterPropGetter,
+  HeaderPropGetter,
+  HeaderProps,
+  Hooks,
+  PluginHook,
+  Renderer,
+  Row,
+  RowPropGetter,
+  TableCellProps,
+  TableFooterProps,
+  TableHeaderProps,
+  TableInstance,
+  TableOptions,
+  TablePropGetter,
+  TableProps,
+  TableRowProps,
+  TableState,
+  UseColumnOrderInstanceProps,
+  UseColumnOrderState,
+  UseExpandedHooks,
+  UseExpandedInstanceProps,
+  UseExpandedOptions,
+  UseExpandedState,
+  UseFiltersColumnOptions,
+  UseFiltersColumnProps,
+  UseFiltersInstanceProps,
+  UseFiltersOptions,
+  UseFiltersState,
+  UseGlobalFiltersInstanceProps,
+  UseGlobalFiltersOptions,
+  UseGlobalFiltersState,
+  UseGroupByCellProps,
+  UseGroupByColumnOptions,
+  UseGroupByColumnProps,
+  UseGroupByHooks,
+  UseGroupByInstanceProps,
+  UseGroupByOptions,
+  UseGroupByRowProps,
+  UseGroupByState,
+  UsePaginationInstanceProps,
+  UsePaginationOptions,
+  UsePaginationState,
+  UseResizeColumnsColumnOptions,
+  UseResizeColumnsColumnProps,
+  UseResizeColumnsOptions,
+  UseResizeColumnsState,
+  UseSortByColumnOptions,
+  UseSortByColumnProps,
+  UseSortByHooks,
+  UseSortByInstanceProps,
+  UseSortByOptions,
+  UseSortByState,
+} from "react-table";
+
+import {
+  UseHvTableStylesTableOptions,
+  UseHvTableStylesColumnOptions,
+  UseHvTableStylesTableCellProps,
+  UseHvTableStylesTableRowProps,
+} from "./useTableStyles";
+import {
+  UseHvTableStickyCellProps,
+  UseHvTableStickyColumnProps,
+  UseHvTableStickyHooks,
+  UseHvTableStickyTableInstance,
+  UseHvTableStickyTableOptions,
+  UseHvTableStickyTableProps,
+} from "./useSticky";
+import { UseHvSortByColumnProps, UseHvSortByTableCellProps } from "./useSortBy";
+import {
+  UseHvRowSelectionHooks,
+  UseHvRowSelectionRowInstance,
+  UseHvRowSelectionState,
+  UseHvRowSelectionTableInstance,
+  UseHvRowSelectionTableOptions,
+  UseHvRowSelectionTableRowProps,
+} from "./useRowSelection";
+import { UseHvPaginationHooks, UseHvPaginationTableInstance } from "./usePagination";
+import {
+  UseHvBulkActionsHooks,
+  UseHvBulkActionsTableInstanceProps,
+  UseHvBulkActionsTableOptions,
+} from "./useBulkActions";
+import {
+  UseHvRowExpandTableOptions,
+  UseHvRowExpandRowInstance,
+  UseHvRowExpandTableRowProps,
+} from "./useRowExpand";
+import {
+  UseHvHeaderGroupsColumnProps,
+  UseHvHeaderGroupsCellProps,
+  UseHvHeaderGroupsInstance,
+} from "./useHeaderGroups";
+import { UseHvResizeColumnProps, UseHvResizeTableCellProps } from "./useResizeColumns";
+
+type Accessor<D extends object> = (
+  originalRow: D,
+  index: number,
+  sub: {
+    subRows: D[];
+    depth: number;
+    data: D[];
+  }
+) => CellValue;
+
+type StringKey<D> = Extract<keyof D, string>;
+type IdType<D> = StringKey<D> | string;
+type CellValue<V = any> = V;
+
+interface HvColumnInterfaceBasedOnValue<D extends object = Record<string, unknown>, V = any> {
+  Cell?: Renderer<HvCellProps<D, V>>;
+}
+
+interface HvColumnGroupInterface<D extends object> {
+  columns: Array<HvTableColumnConfig<D>>;
+}
+
+type HvColumnGroup<D extends object = Record<string, unknown>> = HvTableColumnOptions<D> &
+  HvColumnGroupInterface<D> &
+  (
+    | { Header: string }
+    | ({ id: IdType<D> } & {
+        Header: Renderer<HeaderProps<D>>;
+      })
+  ) & { accessor?: Accessor<D> }; // Not used, but needed for backwards compatibility
+
+type ValueOf<T> = T[keyof T];
+
+// The accessors like `foo.bar` are not supported, use functions instead
+type HvColumnWithStrictAccessor<D extends object = Record<string, unknown>> =
+  HvTableColumnOptions<D> &
+    ValueOf<{
+      [K in keyof D]: {
+        accessor: K;
+      } & HvColumnInterfaceBasedOnValue<D, D[K]>;
+    }>;
+
+type HvColumnWithLooseAccessor<D extends object = Record<string, unknown>> =
+  HvTableColumnOptions<D> &
+    HvColumnInterfaceBasedOnValue<D> &
+    (
+      | { Header: string }
+      | { id: IdType<D> }
+      | { accessor: keyof D extends never ? IdType<D> : never }
+    ) & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> };
+
+export type HvCellProps<D extends object, V = any> = CellProps<D, V> & {
+  column: HvColumnInstance<D>;
+  row: HvRowInstance<D>;
+  cell: HvCellInstance<D, V>;
+};
+
+export type HvTableDefinitionConfig<D extends object = Record<string, unknown>> = HvTableOptions<D>;
+
+export type HvTableColumnConfig<D extends object = Record<string, unknown>> =
+  | HvColumnGroup<D>
+  | HvColumnWithLooseAccessor<D>
+  | HvColumnWithStrictAccessor<D>;
+
+// #region HOOKS
+export interface HvHooks<D extends object = Record<string, unknown>>
+  extends Hooks<D>,
+    UseExpandedHooks<D>,
+    UseGroupByHooks<D>,
+    UseSortByHooks<D>,
+    UseHvRowSelectionHooks<D>,
+    UseHvTableStickyHooks<D>,
+    UseHvPaginationHooks<D>,
+    UseHvBulkActionsHooks<D> {}
+// #endregion
+
+// #region STATE
+export interface HvTableState<D extends object = Record<string, unknown>>
+  extends TableState<D>,
+    UseColumnOrderState<D>,
+    UseExpandedState<D>,
+    UseFiltersState<D>,
+    UseGlobalFiltersState<D>,
+    UseGroupByState<D>,
+    UsePaginationState<D>,
+    UseResizeColumnsState<D>,
+    UseSortByState<D>,
+    UseHvRowSelectionState<D> {
+  rowCount: number;
+}
+// #endregion
+
+// #region OPTIONS
+export interface HvTableOptions<D extends object>
+  extends Omit<TableOptions<D>, "columns" | "data">,
+    UseExpandedOptions<D>,
+    UseFiltersOptions<D>,
+    UseFiltersOptions<D>,
+    UseGlobalFiltersOptions<D>,
+    UseGroupByOptions<D>,
+    UsePaginationOptions<D>,
+    UseResizeColumnsOptions<D>,
+    UseSortByOptions<D>,
+    UseHvTableStylesTableOptions,
+    UseHvRowSelectionTableOptions,
+    UseHvTableStickyTableOptions,
+    UseHvBulkActionsTableOptions,
+    UseHvRowExpandTableOptions {
+  columns?: Array<HvTableColumnConfig<D>>;
+  data?: D[];
+
+  initialState?: Partial<HvTableState<D>>;
+
+  labels?: Record<string, string>;
+}
+
+export interface HvTableColumnOptions<D extends object = Record<string, unknown>>
+  extends ColumnInterface<D>,
+    UseFiltersColumnOptions<D>,
+    UseGroupByColumnOptions<D>,
+    UseResizeColumnsColumnOptions<D>,
+    UseSortByColumnOptions<D>,
+    UseHvTableStylesColumnOptions {}
+// #endregion
+
+// #region INSTANCE
+export interface HvTableInstance<D extends object = Record<string, unknown>>
+  extends TableInstance<D>,
+    Omit<HvTableOptions<D>, "columns" | "pageCount" | "initialState" | "data">,
+    UseColumnOrderInstanceProps<D>,
+    UseExpandedInstanceProps<D>,
+    UseFiltersInstanceProps<D>,
+    UseGlobalFiltersInstanceProps<D>,
+    UseGroupByInstanceProps<D>,
+    UsePaginationInstanceProps<D>,
+    UseSortByInstanceProps<D>,
+    UseHvRowSelectionTableInstance<D>,
+    UseHvTableStickyTableInstance<D>,
+    UseHvHeaderGroupsInstance,
+    UseHvPaginationTableInstance<D>,
+    UseHvBulkActionsTableInstanceProps<D> {
+  initialState: Partial<HvTableState<D>>;
+  state: HvTableState<D>;
+  columns: Array<HvColumnInstance<D>>;
+  allColumns: Array<HvColumnInstance<D>>;
+  visibleColumns: Array<HvColumnInstance<D>>;
+  headers: Array<HvColumnInstance<D>>;
+  flatHeaders: Array<HvColumnInstance<D>>;
+  rows: Array<HvRowInstance<D>>;
+  page: Array<HvRowInstance<D>>;
+  rowsById: Record<string, HvRowInstance<D>>;
+  flatRows: Array<HvRowInstance<D>>;
+  getHooks: () => HvHooks<D>;
+  getTableProps: (propGetter?: TablePropGetter<D>) => HvTableProps;
+  selectedFlatRows: Array<HvRowInstance<D>>;
+
+  initialRows: Array<HvRowInstance<D>>;
+  initialRowsById: Record<string, HvRowInstance<D>>;
+
+  labels: Record<string, string>;
+}
+
+export interface HvColumnInstance<D extends object = Record<string, unknown>>
+  extends ColumnInstance<D>,
+    Omit<HvTableColumnOptions<D>, "id">,
+    UseFiltersColumnProps<D>,
+    UseGroupByColumnProps<D>,
+    UseResizeColumnsColumnProps<D>,
+    UseSortByColumnProps<D> {
+  Cell?: Renderer<HvCellProps<D>>;
+  columns: Array<HvColumnInstance<D>>;
+  parent: HvColumnInstance<D>; // not documented
+  placeholderOf?: HvColumnInstance;
+  getHeaderProps: (propGetter?: HeaderPropGetter<D>) => HvTableHeaderProps;
+  getFooterProps: (propGetter?: FooterPropGetter<D>) => HvTableFooterProps;
+}
+
+export interface HvRowInstance<D extends object = Record<string, unknown>>
+  extends Row<D>,
+    UseGroupByRowProps<D>,
+    UseHvRowSelectionRowInstance,
+    UseHvRowExpandRowInstance<D> {
+  cells: Array<HvCellInstance<D>>;
+  allCells: Array<HvCellInstance<D>>;
+  getRowProps: (propGetter?: RowPropGetter<D>) => HvTableRowProps;
+  index: number;
+  original: D;
+  id: string;
+  subRows: Array<HvRowInstance<D>>;
+}
+
+export interface HvCellInstance<D extends object = Record<string, unknown>, V = any>
+  extends Cell<D, V>,
+    UseGroupByCellProps<D> {
+  column: HvColumnInstance<D>;
+  row: HvRowInstance<D>;
+  getCellProps: (propGetter?: CellPropGetter<D>) => HvTableCellProps;
+}
+// #endregion
+
+// #region PROPS
+export interface HvTableProps extends TableProps, UseHvTableStickyTableProps {}
+
+export interface HvTableHeaderProps
+  extends TableHeaderProps,
+    UseHvTableStylesTableCellProps,
+    UseHvTableStickyColumnProps,
+    UseHvHeaderGroupsColumnProps,
+    UseHvResizeColumnProps,
+    UseHvSortByColumnProps {}
+export interface HvTableFooterProps extends TableFooterProps, UseHvTableStylesTableCellProps {}
+
+export interface HvTableRowProps
+  extends TableRowProps,
+    UseHvTableStylesTableRowProps,
+    UseHvRowSelectionTableRowProps,
+    UseHvRowExpandTableRowProps {}
+
+export interface HvTableCellProps
+  extends TableCellProps,
+    UseHvTableStylesTableCellProps,
+    UseHvTableStickyCellProps,
+    UseHvHeaderGroupsCellProps,
+    UseHvResizeTableCellProps,
+    UseHvSortByTableCellProps {}
+
+// #endregion
+
+export default function useHvTable<D extends object = Record<string, unknown>>(
+  options: HvTableOptions<D>,
+  ...plugins: Array<PluginHook<D>>
+): HvTableInstance<D>;
+
+export { PluginHook as HvTablePluginHook };