@dxc-technology/halstack-react 4.0.1 → 5.0.0

package/resultsetTable/ResultsetTable.stories.tsx

@@ -0,0 +1,275 @@
+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";
+
+export default {
+  title: "Resultset Table",
+  component: DxcResultsetTable,
+};
+
+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 d="M0 0h24v24H0z" fill="none" />
+  </svg>
+);
+
+const columns = [{ displayValue: "Id" }, { displayValue: "Name" }, { displayValue: "City" }];
+
+const rows = [
+  [{ displayValue: "001" }, { displayValue: "Peter" }, { displayValue: "Miami" }],
+  [{ displayValue: "002" }, { displayValue: "Louis" }, { displayValue: "London" }],
+  [{ displayValue: "003" }, { displayValue: "Lana" }, { displayValue: "Amsterdam" }],
+  [{ displayValue: "004" }, { displayValue: "Rick" }, { displayValue: "London" }],
+  [{ displayValue: "005" }, { displayValue: "Mark" }, { displayValue: "Miami" }],
+  [{ displayValue: "006" }, { displayValue: "Cris" }, { displayValue: "Paris" }],
+];
+
+const rowsIcon = [
+  [
+    { displayValue: "001", sortValue: "001" },
+    { displayValue: "Peter" },
+    { displayValue: <DxcButton icon={deleteIcon} /> },
+  ],
+  [{ displayValue: "002", sortValue: "002" }, { displayValue: "Louis" }, { displayValue: "" }],
+  [
+    { displayValue: "003", sortValue: "003" },
+    { displayValue: "Mark" },
+    { displayValue: <DxcButton icon={deleteIcon} /> },
+  ],
+];
+
+const columnsSortable = [
+  { displayValue: "Id", isSortable: true },
+  { displayValue: "Name", isSortable: true },
+  { displayValue: "City", isSortable: false },
+];
+
+const rowsSortable = [
+  [
+    { displayValue: "001", sortValue: "001" },
+    { displayValue: "Peter", sortValue: "Peter" },
+    { displayValue: "Miami", sortValue: "Miami" },
+  ],
+  [
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+  ],
+  [
+    { displayValue: "003", sortValue: "003" },
+    { displayValue: "Aida", sortValue: "Aida" },
+    { displayValue: "Wroclaw", sortValue: "Wroclaw" },
+  ],
+  [
+    { displayValue: "004", sortValue: "004" },
+    { displayValue: "Lana", sortValue: "Lana" },
+    { displayValue: "Amsterdam", sortValue: "Amsterdam" },
+  ],
+];
+
+const longColumns = [
+  { displayValue: "Column1" },
+  { displayValue: "Column2" },
+  { displayValue: "Column3" },
+  { displayValue: "Column4" },
+  { displayValue: "Column5" },
+  { displayValue: "Column6" },
+  { displayValue: "Column7" },
+  { displayValue: "Column8" },
+  { displayValue: "Column9" },
+  { displayValue: "Column10" },
+  { displayValue: "Column11" },
+  { displayValue: "Column12" },
+  { displayValue: "Column13" },
+  { displayValue: "Column14" },
+  { displayValue: "Column15" },
+  { displayValue: "Column16" },
+  { displayValue: "Column17" },
+  { displayValue: "Column18" },
+  { displayValue: "Column19" },
+  { displayValue: "Column20" },
+];
+
+const longRows = [
+  [
+    { displayValue: "001", sortValue: "001" },
+    { displayValue: "Peter", sortValue: "Peter" },
+    { displayValue: "Miami", sortValue: "Miami" },
+    { displayValue: "001", sortValue: "001" },
+    { displayValue: "Peter", sortValue: "Peter" },
+    { displayValue: "Miami", sortValue: "Miami" },
+    { displayValue: "Miami", sortValue: "Miami" },
+    { displayValue: "001", sortValue: "001" },
+    { displayValue: "Peter", sortValue: "Peter" },
+    { displayValue: "Miami", sortValue: "Miami" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "London", sortValue: "London" },
+  ],
+  [
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "London", sortValue: "London" },
+  ],
+  [
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "002", sortValue: "002" },
+    { displayValue: "Louis", sortValue: "Louis" },
+    { displayValue: "London", sortValue: "London" },
+    { displayValue: "London", sortValue: "London" },
+  ],
+];
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Sortable table" theme="light" level={4} />
+      <DxcResultsetTable columns={columnsSortable} rows={rowsSortable}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With action" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rowsIcon}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With items per page option" theme="light" level={4} />
+      <DxcResultsetTable
+        columns={columns}
+        rows={rows}
+        itemsPerPage={2}
+        itemsPerPageOptions={[2, 3]}
+      ></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Scroll resultset table" theme="light" level={4} />
+      <DxcResultsetTable columns={longColumns} rows={longRows}></DxcResultsetTable>
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"xxsmall"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"xsmall"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"small"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"medium"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"large"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"xlarge"}></DxcResultsetTable>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcResultsetTable columns={columns} rows={rows} margin={"xxlarge"}></DxcResultsetTable>
+      <hr />
+    </ExampleContainer>
+  </>
+);
+
+const ResultsetTableAsc = () => (
+  <ExampleContainer>
+    <Title title="Ascendant sorting" theme="light" level={4} />
+    <DxcResultsetTable columns={columnsSortable} rows={rowsSortable}></DxcResultsetTable>
+  </ExampleContainer>
+);
+
+export const AscendentSorting = ResultsetTableAsc.bind({});
+AscendentSorting.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  await userEvent.click(canvas.queryByText("Name"));
+};
+
+const ResultsetTableDesc = () => (
+  <ExampleContainer>
+    <Title title="Descendant sorting" theme="light" level={4} />
+    <DxcResultsetTable columns={columnsSortable} rows={rowsSortable}></DxcResultsetTable>
+  </ExampleContainer>
+);
+
+export const DescendantSorting = ResultsetTableDesc.bind({});
+DescendantSorting.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  await userEvent.click(canvas.queryByText("Name"));
+  await userEvent.click(canvas.queryByText("Name"));
+};
+
+const ResultsetTableMiddle = () => (
+  <ExampleContainer>
+    <Title title="Middle page" theme="light" level={4} />
+    <DxcResultsetTable columns={columns} rows={rows} itemsPerPage={2}></DxcResultsetTable>
+  </ExampleContainer>
+);
+
+export const MiddlePage = ResultsetTableMiddle.bind({});
+MiddlePage.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const nextButton = canvas.getAllByRole("button")[2];
+  await userEvent.click(nextButton);
+};
+
+const ResultsetTableLast = () => (
+  <ExampleContainer>
+    <Title title="Last page" theme="light" level={4} />
+    <DxcResultsetTable columns={columns} rows={rows} itemsPerPage={2}></DxcResultsetTable>
+  </ExampleContainer>
+);
+
+export const LastPage = ResultsetTableLast.bind({});
+LastPage.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const nextButton = canvas.getAllByRole("button")[3];
+  await userEvent.click(nextButton);
+};

package/resultsetTable/ResultsetTable.test.js

@@ -0,0 +1,306 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+
+var _ResultsetTable = _interopRequireDefault(require("./ResultsetTable"));
+
+var columns = [{
+  displayValue: "Id",
+  isSortable: false
+}, {
+  displayValue: "Name",
+  isSortable: true
+}, {
+  displayValue: "City",
+  isSortable: false
+}];
+var rows = [[{
+  displayValue: "001",
+  sortValue: "001"
+}, {
+  displayValue: "Peter",
+  sortValue: "Peter"
+}, {
+  displayValue: "Oviedo",
+  sortValue: "Oviedo"
+}], [{
+  displayValue: "002",
+  sortValue: "002"
+}, {
+  displayValue: "Louis",
+  sortValue: "Louis"
+}, {
+  displayValue: "Oviedo",
+  sortValue: "Oviedo"
+}, {
+  displayValue: ""
+}], [{
+  displayValue: "003",
+  sortValue: "003"
+}, {
+  displayValue: "Lana",
+  sortValue: "Lana"
+}, {
+  displayValue: "Albacete",
+  sortValue: "Albacete"
+}], [{
+  displayValue: "004",
+  sortValue: "004"
+}, {
+  displayValue: "Rick",
+  sortValue: "Rick"
+}, {
+  displayValue: "Albacete",
+  sortValue: "Albacete"
+}], [{
+  displayValue: "005",
+  sortValue: "005"
+}, {
+  displayValue: "Mark",
+  sortValue: "Mark"
+}, {
+  displayValue: "Madrid",
+  sortValue: "Madrid"
+}], [{
+  displayValue: "006",
+  sortValue: "006"
+}, {
+  displayValue: "Cris",
+  sortValue: "Cris"
+}, {
+  displayValue: "Barcelona",
+  sortValue: "Barcelona"
+}, {
+  displayValue: ""
+}], [{
+  displayValue: "007",
+  sortValue: "007"
+}, {
+  displayValue: "Susan",
+  sortValue: "Susan"
+}, {
+  displayValue: "Madrid",
+  sortValue: "Madrid"
+}], [{
+  displayValue: "008",
+  sortValue: "008"
+}, {
+  displayValue: "Tina",
+  sortValue: "Tina"
+}, {
+  displayValue: "Barcelona",
+  sortValue: "Barcelona"
+}], [{
+  displayValue: "009",
+  sortValue: "009"
+}, {
+  displayValue: "Kevin",
+  sortValue: "Kevin"
+}, {
+  displayValue: "Oviedo",
+  sortValue: "Oviedo"
+}, {
+  displayValue: ""
+}], [{
+  displayValue: "010",
+  sortValue: "010"
+}, {
+  displayValue: "Cosmin",
+  sortValue: "Cosmin"
+}, {
+  displayValue: "Barcelona",
+  sortValue: "Barcelona"
+}, {
+  displayValue: ""
+}]];
+var rows2 = [[{
+  displayValue: "546",
+  sortValue: "465"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}], [{
+  displayValue: "978",
+  sortValue: "465"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}, {
+  displayValue: ""
+}], [{
+  displayValue: "678",
+  sortValue: "344"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}, {
+  displayValue: "OtherValue",
+  sortValue: "OtherValue"
+}]];
+describe("ResultsetTable component tests", function () {
+  test("ResultsetTable rendered correctly", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+      columns: columns,
+      rows: rows,
+      itemsPerPage: 3
+    })),
+        getByText = _render.getByText;
+
+    expect(getByText("Peter")).toBeTruthy();
+  });
+  test("Resultsettable 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;
+
+    expect(getAllByRole("row").length - 1).toEqual(3);
+  });
+  test("Resultsettable 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;
+
+    expect(getByText("Peter")).toBeTruthy();
+    expect(getByText("Louis")).toBeTruthy();
+    expect(getByText("Lana")).toBeTruthy();
+    expect(getAllByRole("row").length - 1).toEqual(3);
+    var nextButton = getAllByRole("button")[2];
+
+    _react2.fireEvent.click(nextButton);
+
+    expect(getByText("4 to 6 of 10")).toBeTruthy(); // expect(getByText("Page: 2 of 4")).toBeTruthy();
+
+    expect(getByText("Rick")).toBeTruthy();
+    expect(getByText("Mark")).toBeTruthy();
+    expect(getByText("Cris")).toBeTruthy();
+    expect(getAllByRole("row").length - 1).toEqual(3);
+  });
+  test("Resultsettable 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,
+        getByRole = _render4.getByRole;
+
+    expect(getByText("Peter")).toBeTruthy();
+    expect(getByText("Louis")).toBeTruthy();
+    expect(getByText("Lana")).toBeTruthy();
+    expect(getAllByRole("row").length - 1).toEqual(3);
+    var goToPageSelect = getAllByRole("button")[2];
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(goToPageSelect);
+    });
+    var goToPageOption = getByText("2");
+    (0, _react2.act)(function () {
+      _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("Resultsettable 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;
+
+    var lastButton = getAllByRole("button")[3];
+
+    _react2.fireEvent.click(lastButton);
+
+    expect(getByText("10 to 10 of 10")).toBeTruthy();
+    expect(getAllByRole("row")).toHaveLength(2);
+    expect(getByText("Cosmin")).toBeTruthy();
+  });
+  test("Resultsettable sort rows by column", function () {
+    var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+      columns: columns,
+      rows: rows,
+      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("Resultsettable 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;
+
+    expect(queryByText("Peter")).toBeTruthy();
+    rerender( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+      columns: columns,
+      rows: rows2,
+      itemsPerPage: 3
+    }));
+    expect(queryByText("1 to 3 of 3")).toBeTruthy();
+  });
+  test("Resultsettable 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,
+        queryByText = _render7.queryByText,
+        rerender = _render7.rerender;
+
+    var lastButton = getAllByRole("button")[3];
+
+    _react2.fireEvent.click(lastButton);
+
+    expect(getAllByRole("row").length - 1).toEqual(1);
+    rerender( /*#__PURE__*/_react["default"].createElement(_ResultsetTable["default"], {
+      columns: columns,
+      rows: rows,
+      itemsPerPage: 6
+    }));
+    expect(getAllByRole("row").length - 1).toEqual(6);
+    expect(queryByText("Peter")).toBeTruthy();
+  });
+});

package/resultsetTable/types.d.ts

@@ -0,0 +1,67 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Column = {
+    /**
+     * Column display value.
+     */
+    displayValue: React.ReactNode;
+    /**
+     * Boolean value to indicate whether the column is sortable or not.
+     */
+    isSortable?: boolean;
+};
+declare type Row = {
+    /**
+     * Value to be displayed in the cell.
+     */
+    displayValue: React.ReactNode;
+    /**
+     * Value to be used when sorting the table by that
+     * column. If not indicated displayValue will be used for sorting.
+     */
+    sortValue?: string;
+};
+declare type Props = {
+    /**
+     * An array of objects representing the columns of the table.
+     */
+    columns: Column[];
+    /**
+     * An array of objects representing the rows of the table, you will have
+     * as many objects as columns in the table.
+     */
+    rows: Row[][];
+    /**
+     * If true, a select component for navigation between pages will be displayed.
+     */
+    showGoToPage?: boolean;
+    /**
+     * Number of items per page.
+     */
+    itemsPerPage?: number;
+    /**
+     * An array of numbers representing the items per page options.
+     */
+    itemsPerPageOptions?: number[];
+    /**
+     * 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;
+    /**
+     * 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 given to the sortable icon.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/resultsetTable/types.js

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

package/row/Row.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import RowPropsType from "./types";
+export default function Row({ gutter, align, justify, wrap, reverse, children, }: RowPropsType): JSX.Element;