@hitachivantara/uikit-react-lab 3.38.0

package/dist/Table/hooks/useResizeColumns.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/Table/hooks/useResizeColumns.js"],"names":["getHeaderPropsHook","props","column","resizerProps","getResizerProps","nextProps","resizable","canResize","resizing","isResizing","getCellPropsHook","cell","useInstanceHook","instance","plugins","useResizeColumns","hooks","getHeaderProps","push","getCellProps","useInstance","pluginName"],"mappings":";;;;;;;AAAA;;AAEA;AACO,IAAMA,kBAAkB,GAAG,SAArBA,kBAAqB,CAACC,KAAD,QAAuB;AAAA;;AAAA,MAAbC,MAAa,QAAbA,MAAa;AACvD,MAAMC,YAAY,GAAG,0BAAAD,MAAM,CAACE,eAAP,qFAAAF,MAAM,MAAwB,EAAnD;AAEA,MAAMG,SAAS,GAAG;AAChBC,IAAAA,SAAS,EAAEJ,MAAM,CAACK,SADF;AAEhBC,IAAAA,QAAQ,EAAEN,MAAM,CAACO,UAFD;AAGhBN,IAAAA,YAAY,EAAZA;AAHgB,GAAlB;AAMA,SAAO,CAACF,KAAD,EAAQI,SAAR,CAAP;AACD,CAVM,C,CAYP;;;;;AACO,IAAMK,gBAAgB,GAAG,SAAnBA,gBAAmB,CAACT,KAAD,SAAqB;AAAA,MAAXU,IAAW,SAAXA,IAAW;AACnD,MAAMN,SAAS,GAAG;AAChBC,IAAAA,SAAS,EAAEK,IAAI,CAACT,MAAL,CAAYK,SADP;AAEhBC,IAAAA,QAAQ,EAAEG,IAAI,CAACT,MAAL,CAAYO;AAFN,GAAlB;AAKA,SAAO,CAACR,KAAD,EAAQI,SAAR,CAAP;AACD,CAPM;;;;AASA,IAAMO,eAAe,GAAG,SAAlBA,eAAkB,CAACC,QAAD,EAAc;AAC3C,qCAAkBA,QAAQ,CAACC,OAA3B,EAAoC,CAAC,kBAAD,CAApC,EAA0D,oBAA1D;AACD,CAFM;;;;AAIP,IAAMC,gBAAgB,GAAG,SAAnBA,gBAAmB,CAACC,KAAD,EAAW;AAClC;AACAA,EAAAA,KAAK,CAACC,cAAN,CAAqBC,IAArB,CAA0BlB,kBAA1B,EAFkC,CAGlC;;AACAgB,EAAAA,KAAK,CAACG,YAAN,CAAmBD,IAAnB,CAAwBR,gBAAxB;AAEAM,EAAAA,KAAK,CAACI,WAAN,CAAkBF,IAAlB,CAAuBN,eAAvB;AACD,CAPD;;AASAG,gBAAgB,CAACM,UAAjB,GAA8B,oBAA9B;eAEeN,gB","sourcesContent":["import { ensurePluginOrder } from \"react-table\";\n\n// props target: <table><thead><tr><th>\nexport const getHeaderPropsHook = (props, { column }) => {\n  const resizerProps = column.getResizerProps?.() || {};\n\n  const nextProps = {\n    resizable: column.canResize,\n    resizing: column.isResizing,\n    resizerProps,\n  };\n\n  return [props, nextProps];\n};\n\n// props target: <table><tbody><tr><td>\nexport const getCellPropsHook = (props, { cell }) => {\n  const nextProps = {\n    resizable: cell.column.canResize,\n    resizing: cell.column.isResizing,\n  };\n\n  return [props, nextProps];\n};\n\nexport const useInstanceHook = (instance) => {\n  ensurePluginOrder(instance.plugins, [\"useResizeColumns\"], \"useHvResizeColumns\");\n};\n\nconst useResizeColumns = (hooks) => {\n  // props target: <table><thead><tr><th>\n  hooks.getHeaderProps.push(getHeaderPropsHook);\n  // props target: <table><tbody><tr><td>\n  hooks.getCellProps.push(getCellPropsHook);\n\n  hooks.useInstance.push(useInstanceHook);\n};\n\nuseResizeColumns.pluginName = \"useHvResizeColumns\";\n\nexport default useResizeColumns;\n"],"file":"useResizeColumns.js"}

package/dist/Table/hooks/useRowExpand.d.ts

@@ -0,0 +1,25 @@
+import { MouseEventHandler } from "react";
+import { Hooks, TableExpandedToggleProps, UseExpandedRowProps } from "react-table";
+
+export interface UseHvRowExpandTableRowProps {
+  expanded?: boolean;
+}
+
+export type UseHvRowExpandTableOptions = {
+  disableCreateExpandButton?: boolean;
+};
+
+export interface UseHvRowExpandRowToggleProps extends TableExpandedToggleProps {
+  onClick?: MouseEventHandler<unknown>;
+}
+
+export interface UseHvRowExpandRowInstance<D extends object = Record<string, unknown>>
+  extends UseExpandedRowProps<D> {
+  getToggleRowExpandedProps: (
+    props?: Partial<TableExpandedToggleProps>
+  ) => UseHvRowExpandRowToggleProps;
+}
+
+export default function useRowExpand<D extends object = Record<string, unknown>>(
+  hooks: Hooks<D>
+): void;

package/dist/Table/hooks/useRowExpand.js

@@ -0,0 +1,111 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.visibleColumnsHook = exports.getRowPropsHook = exports.default = exports.DEFAULT_LABELS = exports.CellWithExpandButton = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+require("core-js/modules/es.array.find-index.js");
+
+require("core-js/modules/es.array.splice.js");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _uikitReactCore = require("@hitachivantara/uikit-react-core");
+
+var _uikitReactIcons = require("@hitachivantara/uikit-react-icons");
+
+/* eslint-disable react/prop-types */
+var DEFAULT_LABELS = {
+  expandRowButtonAriaLabel: "Expand this row",
+  collapseRowButtonAriaLabel: "Collapse this row"
+};
+exports.DEFAULT_LABELS = DEFAULT_LABELS;
+
+var CellWithExpandButton = function CellWithExpandButton(_ref) {
+  var row = _ref.row,
+      cell = _ref.cell,
+      labelsProp = _ref.labels;
+  var labels = (0, _uikitReactCore.useLabels)(DEFAULT_LABELS, labelsProp);
+
+  var _row$getToggleRowExpa = row.getToggleRowExpandedProps(),
+      onClick = _row$getToggleRowExpa.onClick;
+
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_uikitReactCore.HvButton, {
+    icon: true,
+    category: "ghost",
+    "aria-label": row.isExpanded ? labels.collapseRowButtonAriaLabel : labels.expandRowButtonAriaLabel,
+    "aria-expanded": row.isExpanded,
+    onClick: onClick
+  }, row.isExpanded ? /*#__PURE__*/_react.default.createElement(_uikitReactIcons.DropDownXS, null) : /*#__PURE__*/_react.default.createElement(_uikitReactIcons.DropRightXS, null)), (cell === null || cell === void 0 ? void 0 : cell.value) && /*#__PURE__*/_react.default.createElement(_uikitReactCore.HvTypography, {
+    variant: "highlightText",
+    component: "span"
+  }, cell.value));
+};
+
+exports.CellWithExpandButton = CellWithExpandButton;
+
+var visibleColumnsHook = function visibleColumnsHook(columns, _ref2) {
+  var instance = _ref2.instance;
+
+  if (instance.disableCreateExpandButton) {
+    return columns;
+  } // add a button to first data column, unless it has a custom renderer
+  // if so, add an extra column instead
+
+
+  var firstDataColumnIndex = columns.findIndex(function (c) {
+    var _c$id;
+
+    return ((_c$id = c.id) === null || _c$id === void 0 ? void 0 : _c$id.indexOf("_hv_")) !== 0;
+  });
+
+  if (firstDataColumnIndex !== -1) {
+    var firstDataColumn = columns[firstDataColumnIndex];
+
+    if (firstDataColumn.Cell == null) {
+      firstDataColumn.Cell = CellWithExpandButton;
+      firstDataColumn.variant = "expand";
+      return columns;
+    }
+  }
+
+  var expandColumn = {
+    id: "_hv_expand",
+    variant: "none",
+    width: 32,
+    // this will only work when using useHvTableSticky
+    // but ensures it stays left of any sticky column
+    sticky: "left",
+    Cell: CellWithExpandButton
+  };
+  var columnsCopy = (0, _toConsumableArray2.default)(columns);
+  columnsCopy.splice(firstDataColumnIndex !== -1 ? firstDataColumnIndex : 0, 0, expandColumn);
+  return columnsCopy;
+};
+
+exports.visibleColumnsHook = visibleColumnsHook;
+
+var getRowPropsHook = function getRowPropsHook(props, _ref3) {
+  var row = _ref3.row;
+  var nextProps = {
+    expanded: row.isExpanded
+  };
+  return [props, nextProps];
+};
+
+exports.getRowPropsHook = getRowPropsHook;
+
+var useRowExpand = function useRowExpand(hooks) {
+  hooks.visibleColumns.push(visibleColumnsHook);
+  hooks.getRowProps.push(getRowPropsHook);
+};
+
+useRowExpand.pluginName = "useHvRowExpand";
+var _default = useRowExpand;
+exports.default = _default;
+//# sourceMappingURL=useRowExpand.js.map

package/dist/Table/hooks/useRowExpand.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/Table/hooks/useRowExpand.js"],"names":["DEFAULT_LABELS","expandRowButtonAriaLabel","collapseRowButtonAriaLabel","CellWithExpandButton","row","cell","labelsProp","labels","getToggleRowExpandedProps","onClick","isExpanded","value","visibleColumnsHook","columns","instance","disableCreateExpandButton","firstDataColumnIndex","findIndex","c","id","indexOf","firstDataColumn","Cell","variant","expandColumn","width","sticky","columnsCopy","splice","getRowPropsHook","props","nextProps","expanded","useRowExpand","hooks","visibleColumns","push","getRowProps","pluginName"],"mappings":";;;;;;;;;;;;;;;AACA;;AAEA;;AACA;;AAJA;AAMO,IAAMA,cAAc,GAAG;AAC5BC,EAAAA,wBAAwB,EAAE,iBADE;AAE5BC,EAAAA,0BAA0B,EAAE;AAFA,CAAvB;;;AAKA,IAAMC,oBAAoB,GAAG,SAAvBA,oBAAuB,OAAuC;AAAA,MAApCC,GAAoC,QAApCA,GAAoC;AAAA,MAA/BC,IAA+B,QAA/BA,IAA+B;AAAA,MAAjBC,UAAiB,QAAzBC,MAAyB;AACzE,MAAMA,MAAM,GAAG,+BAAUP,cAAV,EAA0BM,UAA1B,CAAf;;AAEA,8BAAoBF,GAAG,CAACI,yBAAJ,EAApB;AAAA,MAAQC,OAAR,yBAAQA,OAAR;;AAEA,sBACE,yEACE,6BAAC,wBAAD;AACE,IAAA,IAAI,MADN;AAEE,IAAA,QAAQ,EAAC,OAFX;AAGE,kBACEL,GAAG,CAACM,UAAJ,GAAiBH,MAAM,CAACL,0BAAxB,GAAqDK,MAAM,CAACN,wBAJhE;AAME,qBAAeG,GAAG,CAACM,UANrB;AAOE,IAAA,OAAO,EAAED;AAPX,KASGL,GAAG,CAACM,UAAJ,gBAAiB,6BAAC,2BAAD,OAAjB,gBAAkC,6BAAC,4BAAD,OATrC,CADF,EAYG,CAAAL,IAAI,SAAJ,IAAAA,IAAI,WAAJ,YAAAA,IAAI,CAAEM,KAAN,kBACC,6BAAC,4BAAD;AAAc,IAAA,OAAO,EAAC,eAAtB;AAAsC,IAAA,SAAS,EAAC;AAAhD,KACGN,IAAI,CAACM,KADR,CAbJ,CADF;AAoBD,CAzBM;;;;AA2BA,IAAMC,kBAAkB,GAAG,SAArBA,kBAAqB,CAACC,OAAD,SAA2B;AAAA,MAAfC,QAAe,SAAfA,QAAe;;AAC3D,MAAIA,QAAQ,CAACC,yBAAb,EAAwC;AACtC,WAAOF,OAAP;AACD,GAH0D,CAK3D;AACA;;;AACA,MAAMG,oBAAoB,GAAGH,OAAO,CAACI,SAAR,CAAkB,UAACC,CAAD;AAAA;;AAAA,WAAO,UAAAA,CAAC,CAACC,EAAF,gDAAMC,OAAN,CAAc,MAAd,OAA0B,CAAjC;AAAA,GAAlB,CAA7B;;AAEA,MAAIJ,oBAAoB,KAAK,CAAC,CAA9B,EAAiC;AAC/B,QAAMK,eAAe,GAAGR,OAAO,CAACG,oBAAD,CAA/B;;AAEA,QAAIK,eAAe,CAACC,IAAhB,IAAwB,IAA5B,EAAkC;AAChCD,MAAAA,eAAe,CAACC,IAAhB,GAAuBnB,oBAAvB;AACAkB,MAAAA,eAAe,CAACE,OAAhB,GAA0B,QAA1B;AAEA,aAAOV,OAAP;AACD;AACF;;AAED,MAAMW,YAAY,GAAG;AACnBL,IAAAA,EAAE,EAAE,YADe;AAEnBI,IAAAA,OAAO,EAAE,MAFU;AAInBE,IAAAA,KAAK,EAAE,EAJY;AAMnB;AACA;AACAC,IAAAA,MAAM,EAAE,MARW;AAUnBJ,IAAAA,IAAI,EAAEnB;AAVa,GAArB;AAaA,MAAMwB,WAAW,oCAAOd,OAAP,CAAjB;AACAc,EAAAA,WAAW,CAACC,MAAZ,CAAmBZ,oBAAoB,KAAK,CAAC,CAA1B,GAA8BA,oBAA9B,GAAqD,CAAxE,EAA2E,CAA3E,EAA8EQ,YAA9E;AAEA,SAAOG,WAAP;AACD,CArCM;;;;AAuCA,IAAME,eAAe,GAAG,SAAlBA,eAAkB,CAACC,KAAD,SAAoB;AAAA,MAAV1B,GAAU,SAAVA,GAAU;AACjD,MAAM2B,SAAS,GAAG;AAChBC,IAAAA,QAAQ,EAAE5B,GAAG,CAACM;AADE,GAAlB;AAIA,SAAO,CAACoB,KAAD,EAAQC,SAAR,CAAP;AACD,CANM;;;;AAQP,IAAME,YAAY,GAAG,SAAfA,YAAe,CAACC,KAAD,EAAW;AAC9BA,EAAAA,KAAK,CAACC,cAAN,CAAqBC,IAArB,CAA0BxB,kBAA1B;AACAsB,EAAAA,KAAK,CAACG,WAAN,CAAkBD,IAAlB,CAAuBP,eAAvB;AACD,CAHD;;AAIAI,YAAY,CAACK,UAAb,GAA0B,gBAA1B;eAEeL,Y","sourcesContent":["/* eslint-disable react/prop-types */\nimport React from \"react\";\n\nimport { HvButton, HvTypography, useLabels } from \"@hitachivantara/uikit-react-core\";\nimport { DropDownXS, DropRightXS } from \"@hitachivantara/uikit-react-icons\";\n\nexport const DEFAULT_LABELS = {\n  expandRowButtonAriaLabel: \"Expand this row\",\n  collapseRowButtonAriaLabel: \"Collapse this row\",\n};\n\nexport const CellWithExpandButton = ({ row, cell, labels: labelsProp }) => {\n  const labels = useLabels(DEFAULT_LABELS, labelsProp);\n\n  const { onClick } = row.getToggleRowExpandedProps();\n\n  return (\n    <>\n      <HvButton\n        icon\n        category=\"ghost\"\n        aria-label={\n          row.isExpanded ? labels.collapseRowButtonAriaLabel : labels.expandRowButtonAriaLabel\n        }\n        aria-expanded={row.isExpanded}\n        onClick={onClick}\n      >\n        {row.isExpanded ? <DropDownXS /> : <DropRightXS />}\n      </HvButton>\n      {cell?.value && (\n        <HvTypography variant=\"highlightText\" component=\"span\">\n          {cell.value}\n        </HvTypography>\n      )}\n    </>\n  );\n};\n\nexport const visibleColumnsHook = (columns, { instance }) => {\n  if (instance.disableCreateExpandButton) {\n    return columns;\n  }\n\n  // add a button to first data column, unless it has a custom renderer\n  // if so, add an extra column instead\n  const firstDataColumnIndex = columns.findIndex((c) => c.id?.indexOf(\"_hv_\") !== 0);\n\n  if (firstDataColumnIndex !== -1) {\n    const firstDataColumn = columns[firstDataColumnIndex];\n\n    if (firstDataColumn.Cell == null) {\n      firstDataColumn.Cell = CellWithExpandButton;\n      firstDataColumn.variant = \"expand\";\n\n      return columns;\n    }\n  }\n\n  const expandColumn = {\n    id: \"_hv_expand\",\n    variant: \"none\",\n\n    width: 32,\n\n    // this will only work when using useHvTableSticky\n    // but ensures it stays left of any sticky column\n    sticky: \"left\",\n\n    Cell: CellWithExpandButton,\n  };\n\n  const columnsCopy = [...columns];\n  columnsCopy.splice(firstDataColumnIndex !== -1 ? firstDataColumnIndex : 0, 0, expandColumn);\n\n  return columnsCopy;\n};\n\nexport const getRowPropsHook = (props, { row }) => {\n  const nextProps = {\n    expanded: row.isExpanded,\n  };\n\n  return [props, nextProps];\n};\n\nconst useRowExpand = (hooks) => {\n  hooks.visibleColumns.push(visibleColumnsHook);\n  hooks.getRowProps.push(getRowPropsHook);\n};\nuseRowExpand.pluginName = \"useHvRowExpand\";\n\nexport default useRowExpand;\n"],"file":"useRowExpand.js"}

package/dist/Table/hooks/useRowSelection.d.ts

@@ -0,0 +1,75 @@
+import { ChangeEvent } from "react";
+import { Hooks, IdType, PropGetter, Row } from "react-table";
+
+// getRowProps:
+export interface UseHvRowSelectionTableRowProps {
+  selected?: boolean;
+}
+
+export interface UseHvRowSelectionRowCheckboxProps {
+  onChange?: (e: ChangeEvent, checked?: boolean) => void;
+  checked?: boolean;
+  disabled?: boolean;
+  indeterminate?: boolean;
+}
+
+export interface UseHvRowSelectionBulkCheckboxProps {
+  onChange?: (e: ChangeEvent, checked?: boolean) => void;
+  checked?: boolean;
+  indeterminate?: boolean;
+}
+
+export type UseHvRowSelectionTableOptions = Partial<{
+  autoResetSelectedRows: boolean;
+  autoResetLockedSelectionRows: boolean;
+  selectSubRows: boolean;
+  manualRowSelectedKey: string;
+  applyToggleAllRowsSelectedToPrefilteredRows: boolean;
+}>;
+
+export interface UseHvRowSelectionHooks<D extends object> {
+  getToggleRowSelectedProps: Array<PropGetter<D, UseHvRowSelectionRowCheckboxProps>>;
+  getToggleAllRowsSelectedProps: Array<PropGetter<D, UseHvRowSelectionBulkCheckboxProps>>;
+  getToggleAllPageRowsSelectedProps: Array<PropGetter<D, UseHvRowSelectionBulkCheckboxProps>>;
+}
+
+export interface UseHvRowSelectionState<D extends object> {
+  selectedRowIds: Record<IdType<D>, boolean>;
+  lockedSelectionRowIds: Record<IdType<D>, boolean>;
+}
+
+export interface UseHvRowSelectionTableInstance<D extends object> {
+  toggleRowSelected: (rowId: IdType<D>, set?: boolean) => void;
+  toggleAllRowsSelected: (value?: boolean) => void;
+  toggleAllPageRowsSelected: (value?: boolean) => void;
+  getToggleAllRowsSelectedProps: (
+    props?: Partial<UseHvRowSelectionBulkCheckboxProps>
+  ) => UseHvRowSelectionBulkCheckboxProps;
+  getToggleAllPageRowsSelectedProps: (
+    props?: Partial<UseHvRowSelectionBulkCheckboxProps>
+  ) => UseHvRowSelectionBulkCheckboxProps;
+
+  isNoRowsSelected: boolean;
+  isNoPageRowsSelected: boolean;
+  isAllRowsSelected: boolean;
+  isAllPageRowsSelected: boolean;
+  isAllSelectableRowsSelected: boolean;
+  isAllSelectablePageRowsSelected: boolean;
+  isAllSelectableRowsUnselected: boolean;
+  isAllSelectablePageRowsUnselected: boolean;
+
+  selectedFlatRows: Array<Row<D>>;
+}
+
+export interface UseHvRowSelectionRowInstance {
+  isSelected: boolean;
+  isSomeSelected: boolean;
+  toggleRowSelected: (set?: boolean) => void;
+  getToggleRowSelectedProps: (
+    props?: Partial<UseHvRowSelectionRowCheckboxProps>
+  ) => UseHvRowSelectionRowCheckboxProps;
+}
+
+export default function useRowSelection<D extends object = Record<string, unknown>>(
+  hooks: Hooks<D>
+): void;