@dxc-technology/halstack-react 10.1.0 → 12.0.0

package/{resultsetTable → resultset-table}/ResultsetTable.stories.tsx

@@ -1,19 +1,31 @@
 import React from "react";
 import DxcResultsetTable from "./ResultsetTable";
-import DxcButton from "../button/Button";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import { userEvent, within } from "@storybook/testing-library";
 import styled from "styled-components";
+import { HalstackProvider } from "../HalstackContext";
+import { disabledRules } from "../../test/accessibility/rules/specific/resultset-table/disabledRules";
+import preview from "../../.storybook/preview";
 
 export default {
   title: "Resultset Table",
   component: DxcResultsetTable,
+  parameters: {
+    a11y: {
+      config: {
+        rules: [
+          ...disabledRules.map((ruleId) => ({ id: ruleId, reviewOnFail: true })),
+          ...preview?.parameters?.a11y?.config?.rules,
+        ],
+      },
+    },
+  },
 };
 
 const deleteIcon = (
   <svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
-    <path d="M6 19c0 1.1.9 2 2 2h8c1.1 0 2-.9 2-2V7H6v12zM19 4h-3.5l-1-1h-5l-1 1H5v2h14V4z" />
+    <path fill="currentColor" d="M6 19c0 1.1.9 2 2 2h8c1.1 0 2-.9 2-2V7H6v12zM19 4h-3.5l-1-1h-5l-1 1H5v2h14V4z" />
     <path d="M0 0h24v24H0z" fill="none" />
   </svg>
 );
@@ -29,17 +41,77 @@ const rows = [
   [{ displayValue: "006" }, { displayValue: "Cris" }, { displayValue: "Paris" }],
 ];
 
+const advancedTheme = {
+  table: {
+    actionIconColor: "#1B75BB",
+    hoverActionIconColor: "#1B75BB",
+    activeActionIconColor: "#1B75BB",
+    focusActionIconColor: "#1B75BB",
+    disabledActionIconColor: "#666666",
+    hoverButtonBackgroundColor: "#cccccc",
+  },
+};
+
+const actions = [
+  {
+    title: "icon",
+    onClick: (value?) => {
+      console.log(value);
+    },
+    options: [
+      {
+        value: "1",
+        label: "Amazon with a very long text",
+      },
+      {
+        value: "2",
+        label: "Ebay",
+      },
+      {
+        value: "3",
+        label: "Apple",
+      },
+    ],
+  },
+  {
+    icon: "filled_edit",
+    title: "icon",
+    onClick: () => {},
+  },
+  {
+    icon: deleteIcon,
+    title: "icon",
+    onClick: () => {},
+    disabled: true,
+  },
+  {
+    icon: deleteIcon,
+    title: "icon",
+    onClick: () => {},
+  },
+];
+
 const rowsIcon = [
   [
     { displayValue: "001", sortValue: "001" },
     { displayValue: "Peter" },
-    { displayValue: <DxcButton icon={deleteIcon} /> },
+    {
+      displayValue: <DxcResultsetTable.ActionsCell actions={actions} />,
+    },
+  ],
+  [
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis" },
+    {
+      displayValue: <DxcResultsetTable.ActionsCell actions={actions} />,
+    },
   ],
-  [{ displayValue: "002", sortValue: "002" }, { displayValue: "Louis" }, { displayValue: "" }],
   [
     { displayValue: "003", sortValue: "003" },
     { displayValue: "Mark" },
-    { displayValue: <DxcButton icon={deleteIcon} /> },
+    {
+      displayValue: <DxcResultsetTable.ActionsCell actions={actions} />,
+    },
   ],
 ];
 
@@ -200,12 +272,35 @@ export const Chromatic = () => (
       <Title title="Scroll resultset table" theme="light" level={4} />
       <DxcResultsetTable columns={longColumns} rows={longRows} />
     </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Without paginator" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} hidePaginator />
+    </ExampleContainer>
     <ExampleContainer>
       <SmallContainer>
         <Title title="Small container and text overflow" theme="light" level={4} />
         <DxcResultsetTable columns={columnsSortable} rows={longValues} />
       </SmallContainer>
     </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Reduced sortable table" theme="light" level={4} />
+      <DxcResultsetTable columns={columnsSortable} rows={rowsSortable} mode="reduced" />
+    </ExampleContainer>
+    {/* PENDING SMALL ICON VERSION */}
+    <ExampleContainer>
+      <Title title="Reduced with items per page option" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} itemsPerPage={2} itemsPerPageOptions={[2, 3]} mode="reduced" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Reduced scroll resultset table" theme="light" level={4} />
+      <DxcResultsetTable columns={longColumns} rows={longRows} mode="reduced" />
+    </ExampleContainer>
+    <ExampleContainer>
+      <SmallContainer>
+        <Title title="Reduced small container and text overflow" theme="light" level={4} />
+        <DxcResultsetTable columns={columnsSortable} rows={longValues} mode="reduced" />
+      </SmallContainer>
+    </ExampleContainer>
     <Title title="Margins" theme="light" level={2} />
     <ExampleContainer>
       <Title title="Xxsmall" theme="light" level={4} />
@@ -298,3 +393,21 @@ LastPage.play = async ({ canvasElement }) => {
   const nextButton = canvas.getAllByRole("button")[3];
   await userEvent.click(nextButton);
 };
+
+const ResultsetActionsCellDropdown = () => (
+  <ExampleContainer>
+    <Title title="Dropdown Action" theme="light" level={4} />
+    <DxcResultsetTable columns={columns} rows={rowsIcon} itemsPerPage={2} />
+    <Title title="Custom theme actions cell" theme="light" level={4} />
+    <HalstackProvider advancedTheme={advancedTheme}>
+      <DxcResultsetTable columns={columns} rows={rowsIcon} itemsPerPage={2} />
+    </HalstackProvider>
+  </ExampleContainer>
+);
+
+export const DropdownAction = ResultsetActionsCellDropdown.bind({});
+DropdownAction.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const dropdown = canvas.getAllByRole("button")[5];
+  await userEvent.click(dropdown);
+};

package/{resultsetTable → resultset-table}/ResultsetTable.test.js

@@ -1,19 +1,14 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@testing-library/react");
-
 var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
-
 var _ResultsetTable = _interopRequireDefault(require("./ResultsetTable.tsx"));
-
 // Mocking DOMRect for Radix Primitive Popover
 global.globalThis = global;
 global.DOMRect = {
@@ -28,12 +23,10 @@ global.DOMRect = {
     };
   }
 };
-
 global.ResizeObserver = /*#__PURE__*/function () {
   function ResizeObserver() {
     (0, _classCallCheck2["default"])(this, ResizeObserver);
   }
-
   (0, _createClass2["default"])(ResizeObserver, [{
     key: "observe",
     value: function observe() {}
@@ -46,7 +39,18 @@ global.ResizeObserver = /*#__PURE__*/function () {
   }]);
   return ResizeObserver;
 }();
-
+var icon = /*#__PURE__*/_react["default"].createElement("svg", {
+  xmlns: "http://www.w3.org/2000/svg",
+  height: "24px",
+  viewBox: "0 0 24 24",
+  width: "24px",
+  fill: "currentColor"
+}, /*#__PURE__*/_react["default"].createElement("path", {
+  d: "M0 0h24v24H0V0zm0 0h24v24H0V0z",
+  fill: "none"
+}), /*#__PURE__*/_react["default"].createElement("path", {
+  d: "M1 9l2 2c4.97-4.97 13.03-4.97 18 0l2-2C16.93 2.93 7.08 2.93 1 9zm8 8l3 3 3-3c-1.65-1.66-4.34-1.66-6 0zm-4-4l2 2c2.76-2.76 7.24-2.76 10 0l2-2C15.14 9.14 8.87 9.14 5 13z"
+}));
 var columns = [{
   displayValue: "Id",
   isSortable: false
@@ -181,92 +185,88 @@ var rows2 = [[{
 describe("Resultset table component tests", function () {
   test("Resultset table rendered correctly", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        getByText = _render.getByText;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3
+      })),
+      getByText = _render.getByText;
     expect(getByText("Peter")).toBeTruthy();
   });
   test("Resultset table shows as many rows as itemsPerPage", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        getAllByRole = _render2.getAllByRole;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3
+      })),
+      getAllByRole = _render2.getAllByRole;
     expect(getAllByRole("row").length - 1).toEqual(3);
   });
   test("Resultset table shows rows on second page", function () {
     var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        getByText = _render3.getByText,
-        getAllByRole = _render3.getAllByRole;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3
+      })),
+      getByText = _render3.getByText,
+      getAllByRole = _render3.getAllByRole;
     expect(getByText("Peter")).toBeTruthy();
     expect(getByText("Louis")).toBeTruthy();
     expect(getByText("Lana")).toBeTruthy();
     expect(getAllByRole("row").length - 1).toEqual(3);
     var nextButton = getAllByRole("button")[3];
-
     _react2.fireEvent.click(nextButton);
-
-    expect(getByText("4 to 6 of 10")).toBeTruthy();
-    expect(getByText("Rick")).toBeTruthy();
-    expect(getByText("Mark")).toBeTruthy();
-    expect(getByText("Cris")).toBeTruthy();
-    expect(getAllByRole("row").length - 1).toEqual(3);
-  });
-  test("Resultset table goToPage works as expected", function () {
-    window.HTMLElement.prototype.scrollIntoView = function () {};
-
-    window.HTMLElement.prototype.scrollTo = function () {};
-
-    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      showGoToPage: true,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        getByText = _render4.getByText,
-        getAllByRole = _render4.getAllByRole;
-
-    expect(getByText("Peter")).toBeTruthy();
-    expect(getByText("Louis")).toBeTruthy();
-    expect(getByText("Lana")).toBeTruthy();
-    expect(getAllByRole("row").length - 1).toEqual(3);
-    var goToPageSelect = getAllByRole("button")[3];
-
-    _userEvent["default"].click(goToPageSelect);
-
-    var goToPageOption = getByText("2");
-
-    _userEvent["default"].click(goToPageOption);
-
     expect(getByText("4 to 6 of 10")).toBeTruthy();
     expect(getByText("Rick")).toBeTruthy();
     expect(getByText("Mark")).toBeTruthy();
     expect(getByText("Cris")).toBeTruthy();
     expect(getAllByRole("row").length - 1).toEqual(3);
   });
+  test("Resultset table goToPage works as expected", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var _render4, getByText, getAllByRole, goToPageSelect, goToPageOption;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          window.HTMLElement.prototype.scrollIntoView = function () {};
+          window.HTMLElement.prototype.scrollTo = function () {};
+          _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+            columns: columns,
+            showGoToPage: true,
+            rows: rows,
+            itemsPerPage: 3
+          })), getByText = _render4.getByText, getAllByRole = _render4.getAllByRole;
+          expect(getByText("Peter")).toBeTruthy();
+          expect(getByText("Louis")).toBeTruthy();
+          expect(getByText("Lana")).toBeTruthy();
+          expect(getAllByRole("row").length - 1).toEqual(3);
+          goToPageSelect = getAllByRole("button")[3];
+          _context.next = 10;
+          return _userEvent["default"].click(goToPageSelect);
+        case 10:
+          goToPageOption = getByText("2");
+          _context.next = 13;
+          return _userEvent["default"].click(goToPageOption);
+        case 13:
+          expect(getByText("4 to 6 of 10")).toBeTruthy();
+          expect(getByText("Rick")).toBeTruthy();
+          expect(getByText("Mark")).toBeTruthy();
+          expect(getByText("Cris")).toBeTruthy();
+          expect(getAllByRole("row").length - 1).toEqual(3);
+        case 18:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
   test("Resultset table going to the last page shows only one row", function () {
     var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        getByText = _render5.getByText,
-        getAllByRole = _render5.getAllByRole;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3
+      })),
+      getByText = _render5.getByText,
+      getAllByRole = _render5.getAllByRole;
     var lastButton = getAllByRole("button")[4];
-
     _react2.fireEvent.click(lastButton);
-
     expect(getByText("10 to 10 of 10")).toBeTruthy();
     expect(getAllByRole("row")).toHaveLength(2);
     expect(getByText("Cosmin")).toBeTruthy();
@@ -278,26 +278,21 @@ describe("Resultset table component tests", function () {
       itemsPerPage: 3
     }));
     expect(component.queryByText("Peter")).toBeTruthy();
-
     _react2.fireEvent.click(component.queryByText("Name"));
-
     expect(component.queryByText("Tina")).not.toBeTruthy();
     expect(component.queryByText("Cosmin")).toBeTruthy();
-
     _react2.fireEvent.click(component.queryByText("Name"));
-
     expect(component.queryByText("Tina")).toBeTruthy();
     expect(component.queryByText("Cosmin")).not.toBeTruthy();
   });
   test("Resultset table change rows should go to first page", function () {
     var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3
-    })),
-        queryByText = _render6.queryByText,
-        rerender = _render6.rerender;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3
+      })),
+      queryByText = _render6.queryByText,
+      rerender = _render6.rerender;
     expect(queryByText("Peter")).toBeTruthy();
     rerender( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
       columns: columns,
@@ -308,18 +303,79 @@ describe("Resultset table component tests", function () {
   });
   test("Resultset table change itemsPerPage should go to first page", function () {
     var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
-      columns: columns,
-      rows: rows,
-      itemsPerPage: 3,
-      itemsPerPageOptions: [2, 3]
-    })),
-        getAllByRole = _render7.getAllByRole;
-
+        columns: columns,
+        rows: rows,
+        itemsPerPage: 3,
+        itemsPerPageOptions: [2, 3]
+      })),
+      getAllByRole = _render7.getAllByRole;
     var lastButton = getAllByRole("button")[4];
     expect(getAllByRole("row").length - 1).toEqual(3);
-
     _react2.fireEvent.click(lastButton);
-
     expect(getAllByRole("row").length - 1).toEqual(1);
   });
+  test("Resultset table may not use the paginator", function () {
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+        columns: columns,
+        rows: rows,
+        hidePaginator: true
+      })),
+      getAllByRole = _render8.getAllByRole;
+    var nextButton = getAllByRole("button")[3];
+    expect(nextButton).not.toBeTruthy();
+  });
+  test("Resultset table with ActionsCell", function () {
+    var onSelectOption = jest.fn();
+    var onClick = jest.fn();
+    var actions = [{
+      icon: icon,
+      title: "icon1",
+      onClick: onSelectOption,
+      options: [{
+        value: "1",
+        label: "Amazon"
+      }, {
+        value: "2",
+        label: "Ebay"
+      }, {
+        value: "3",
+        label: "Aliexpress"
+      }]
+    }, {
+      icon: icon,
+      title: "icon2",
+      onClick: onClick
+    }];
+    var actionRows = [[{
+      displayValue: "001",
+      sortValue: "001"
+    }, {
+      displayValue: "Peter",
+      sortValue: "Peter"
+    }, {
+      displayValue: /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"].ActionsCell, {
+        actions: actions
+      }),
+      sortValue: "Actions"
+    }]];
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+        columns: columns,
+        rows: actionRows,
+        itemsPerPage: 3
+      })),
+      getAllByRole = _render9.getAllByRole,
+      getByRole = _render9.getByRole,
+      getByText = _render9.getByText;
+    var dropdown = getAllByRole("button")[2];
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(dropdown);
+    });
+    expect(getByRole("menu")).toBeTruthy();
+    var option = getByText("Aliexpress");
+    _userEvent["default"].click(option);
+    expect(onSelectOption).toHaveBeenCalledWith("3");
+    var action = getAllByRole("button")[1];
+    _userEvent["default"].click(action);
+    expect(onClick).toHaveBeenCalled();
+  });
 });

package/{resultsetTable → resultset-table}/types.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-export declare type Column = {
+export type Column = {
     /**
      * Column display value.
      */
@@ -16,7 +16,7 @@ export declare type Column = {
      */
     isSortable?: boolean;
 };
-declare type Row = {
+export type Row = {
     /**
      * Value to be displayed in the cell.
      */
@@ -27,7 +27,7 @@ declare type Row = {
      */
     sortValue?: string;
 };
-declare type Props = {
+type CommonProps = {
     /**
      * An array of objects representing the columns of the table.
      */
@@ -37,6 +37,24 @@ declare type Props = {
      * as many objects as columns in the table.
      */
     rows: Row[][];
+    /**
+     * Size of the margin to be applied to the component. You can pass an object with 'top',
+     * 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     */
+    margin?: Space | Margin;
+    /**
+     * Value of the tabindex attribute applied to the sortable icon.
+     */
+    tabIndex?: number;
+    /**
+     * Determines the visual style and layout
+     * - "default": The default mode with big spacing
+     * - "reduced": A reduced mode with minimal spacing for dense tables
+     */
+    mode?: "default" | "reduced";
+};
+type PaginatedProps = CommonProps & {
+    hidePaginator?: false;
     /**
      * If true, a select component for navigation between pages will be displayed.
      */
@@ -53,15 +71,30 @@ declare type Props = {
      * This function will be called when the user selects an item per page
      * option. The value selected will be passed as a parameter.
      */
-    itemsPerPageFunction?: (newValue: number) => void;
+    itemsPerPageFunction?: (value: number) => void;
+};
+type NonPaginatedProps = CommonProps & {
     /**
-     * Size of the margin to be applied to the component. You can pass an object with 'top',
-     * 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     * If true, paginator will not be displayed.
      */
-    margin?: Space | Margin;
+    hidePaginator: true;
     /**
-     * Value of the tabindex attribute given to the sortable icon.
+     * If true, a select component for navigation between pages will be displayed.
      */
-    tabIndex?: number;
+    showGoToPage?: never;
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: never;
+    /**
+     * An array of numbers representing the items per page options.
+     */
+    itemsPerPageOptions?: never;
+    /**
+     * This function will be called when the user selects an item per page
+     * option. The value selected will be passed as a parameter.
+     */
+    itemsPerPageFunction?: never;
 };
+type Props = PaginatedProps | NonPaginatedProps;
 export default Props;

package/resultset-table/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});