@dxc-technology/halstack-react 0.0.0-9a4715c → 0.0.0-9b45027

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/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,11 @@
+import React from "react";
+declare type RowProps = {
+    gutter?: "none" | "xxxsmall" | "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge" | "xxxlarge";
+    align?: "start" | "center" | "end" | "baseline" | "stretch";
+    justify?: "start" | "center" | "end" | "spaceBetween" | "spaceAround" | "spaceEvenly";
+    wrap?: boolean;
+    reverse?: boolean;
+    children: React.ReactNode;
+};
+export default function Row({ gutter, align, justify, wrap, reverse, children }: RowProps): JSX.Element;
+export {};

package/row/Row.js

@@ -0,0 +1,127 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = Row;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _templateObject;
+
+function Row(_ref) {
+  var _ref$gutter = _ref.gutter,
+      gutter = _ref$gutter === void 0 ? "none" : _ref$gutter,
+      align = _ref.align,
+      justify = _ref.justify,
+      _ref$wrap = _ref.wrap,
+      wrap = _ref$wrap === void 0 ? true : _ref$wrap,
+      _ref$reverse = _ref.reverse,
+      reverse = _ref$reverse === void 0 ? false : _ref$reverse,
+      children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement(StyledRow, {
+    gutter: gutter,
+    align: align,
+    justify: justify,
+    wrap: wrap,
+    reverse: reverse
+  }, children);
+}
+
+var StyledRow = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: ", ";\n  flex-wrap: ", ";\n  align-items: ", ";\n  justify-content: ", ";\n  gap: ", ";\n"])), function (_ref2) {
+  var reverse = _ref2.reverse;
+  return reverse ? "row-reverse" : "row";
+}, function (_ref3) {
+  var wrap = _ref3.wrap;
+  return wrap ? "wrap" : "nowrap";
+}, function (_ref4) {
+  var align = _ref4.align;
+
+  switch (align) {
+    case "start":
+      return "flex-start";
+
+    case "center":
+      return "center";
+
+    case "end":
+      return "flex-end";
+
+    case "baseline":
+      return "baseline";
+
+    case "stretch":
+      return "stretch";
+
+    default:
+      return "initial";
+  }
+}, function (_ref5) {
+  var justify = _ref5.justify;
+
+  switch (justify) {
+    case "spaceBetween":
+      return "space-between";
+
+    case "spaceAround":
+      return "space-around";
+
+    case "spaceEvenly":
+      return "space-evenly";
+
+    case "start":
+      return "flex-start";
+
+    case "center":
+      return "center";
+
+    case "end":
+      return "flex-end";
+
+    default:
+      return "initial";
+  }
+}, function (_ref6) {
+  var gutter = _ref6.gutter;
+
+  switch (gutter) {
+    case "none":
+      return "0";
+
+    case "xxxsmall":
+      return "0.125rem";
+
+    case "xxsmall":
+      return "0.25rem";
+
+    case "xsmall":
+      return "0.5rem";
+
+    case "small":
+      return "1rem";
+
+    case "medium":
+      return "1.5rem";
+
+    case "large":
+      return "2rem";
+
+    case "xlarge":
+      return "3rem";
+
+    case "xxlarge":
+      return "4rem";
+
+    case "xxxlarge":
+      return "5rem";
+
+    default:
+      return "0";
+  }
+});