@dxc-technology/halstack-react 0.0.0-0da54d8 → 0.0.0-0e7fa98

package/number-input/numberInputContextTypes.d.ts

@@ -0,0 +1,19 @@
+declare type Props = {
+    /**
+     * Type of the input.
+     */
+    typeNumber?: string;
+    /**
+     * Minimum value allowed by the number input.
+     */
+    minNumber?: number;
+    /**
+     * Maximum value allowed by the number input.
+     */
+    maxNumber?: number;
+    /**
+     * The step interval to use when using the up and down arrows to adjust the value.
+     */
+    stepNumber?: number;
+};
+export default Props;

package/number-input/numberInputContextTypes.js

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

package/number-input/types.d.ts

@@ -0,0 +1,124 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Text to be placed above the number.
+     */
+    label?: string;
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * Initial value of the input element, only when it is uncontrolled.
+     */
+    defaultValue?: string;
+    /**
+     * Value of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
+     */
+    value?: string;
+    /**
+     * Helper text to be placed above the number.
+     */
+    helperText?: string;
+    /**
+     * Text to be put as placeholder of the number.
+     */
+    placeholder?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the number will be optional, showing '(Optional)'
+     * next to the label. Otherwise, the field will be considered required
+     * and an error will be passed as a parameter to the OnBlur and onChange
+     * functions when it has not been filled.
+     */
+    optional?: boolean;
+    /**
+     * Prefix to be placed before the number value.
+     */
+    prefix?: string;
+    /**
+     * Suffix to be placed after the number value.
+     */
+    suffix?: string;
+    /**
+     * Minimum value allowed by the number input. If the typed value by the user is
+     * lower than min, the onBlur and onChange functions will be called with
+     * the current value and an internal error informing that the current
+     * value is not correct. If a valid state is reached, the error parameter
+     * will not be defined in both events.
+     */
+    min?: number;
+    /**
+     * Maximum value allowed by the number input. If the typed value by the user
+     * surpasses max, the onBlur and onChange functions will be called with
+     * the current value and an internal error informing that the current
+     * value is not correct. If a valid state is reached, the error parameter
+     * will not be defined in both events.
+     */
+    max?: number;
+    /**
+     * The step interval to use when using the up and down arrows to adjust the value.
+     */
+    step?: number;
+    /**
+     * This function will be called when the user types within the input
+     * element of the component. An object including the current value and
+     * the error (if the value entered is not valid) will be passed to this
+     * function. If there is no error, error will not be defined.
+     */
+    onChange?: (val: {
+        value: string;
+        error?: string;
+    }) => void;
+    /**
+     * This function will be called when the input element loses the focus.
+     * An object including the input value and the error (if the value
+     * entered is not valid) will be passed to this function. If there is no error,
+     * error will not be defined.
+     */
+    onBlur?: (val: {
+        value: string;
+        error?: string;
+    }) => void;
+    /**
+     * If it is a defined value and also a truthy string, the component will
+     * change its appearance, showing the error below the input component. If
+     * the defined value is an empty string, it will reserve a space below
+     * the component for a future error, but it would not change its look. In
+     * case of being undefined or null, both the appearance and the space for
+     * the error message would not be modified.
+     */
+    error?: string;
+    /**
+     * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value.
+     * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
+     */
+    autocomplete?: string;
+    /**
+     * Size of the margin to be applied to the component ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
+     * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
+     */
+    margin?: Space | Margin;
+    /**
+     * Size of the component ('small' | 'medium' | 'large' | 'fillParent').
+     */
+    size?: "small" | "medium" | "large" | "fillParent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/number-input/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxc-technology/halstack-react",
-  "version": "0.0.0-0da54d8",
+  "version": "0.0.0-0e7fa98",
   "description": "DXC Halstack React components library",
   "repository": "dxc-technology/halstack-react",
   "homepage": "http://developer.dxc.com/tools/react",
@@ -24,18 +24,21 @@
     "@material-ui/lab": "4.0.0-alpha.17",
     "@material-ui/pickers": "3.2.2",
     "@material-ui/styles": "4.0.2",
+    "@types/styled-components": "^5.1.24",
+    "@types/uuid": "^8.3.4",
     "color": "^3.1.3",
     "date-fns": "^2.0.0-beta.4",
     "moment": "2.24.0",
     "prop-types": "^15.7.2",
     "rgb-hex": "^3.0.0",
+    "slugify": "^1.6.5",
     "uuid": "^8.3.2"
   },
   "scripts": {
     "test": "jest",
     "test:watch": "npm test -- --watch --coverage",
     "build": "babel src --extensions .js,.jsx,.ts,.tsx --out-dir ../dist --copy-files --verbose && node ../scripts/build/copy-package.js && tsc ",
-    "build:watch": "babel src --watch --out-dir ../dist --copy-files --verbose",
+    "build:watch": "babel src --watch --extensions .js,.jsx,.ts,.tsx --out-dir ../dist --copy-files --verbose",
     "storybook": "start-storybook -p 6006",
     "build-storybook": "build-storybook"
   },
@@ -52,8 +55,8 @@
     "@storybook/addon-essentials": "^6.4.9",
     "@storybook/addon-links": "^6.4.9",
     "@storybook/react": "^6.4.9",
-    "@testing-library/react": "^11.2.5",
     "@storybook/testing-library": "0.0.7",
+    "@testing-library/react": "^11.2.5",
     "@testing-library/user-event": "^12.6.3",
     "babel-jest": "^24.8.0",
     "babel-loader": "^8.0.6",

package/paginator/Paginator.js

@@ -15,7 +15,7 @@ var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _useTheme = _interopRequireDefault(require("../useTheme.js"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
 
 var _Button = _interopRequireDefault(require("../button/Button"));
 
@@ -23,7 +23,7 @@ var _Select = _interopRequireDefault(require("../select/Select"));
 
 var _Icons = require("./Icons");
 
-var _BackgroundColorContext = require("../BackgroundColorContext.js");
+var _BackgroundColorContext = require("../BackgroundColorContext");
 
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9;
 
@@ -67,9 +67,6 @@ var DxcPaginator = function DxcPaginator(_ref) {
     },
     value: itemsPerPage.toString(),
     size: "fillParent",
-    margin: {
-      top: "xsmall"
-    },
     tabIndex: tabIndex
   }))), /*#__PURE__*/_react["default"].createElement(TotalItemsContainer, null, minItemsPerPage, " to ", maxItemsPerPage, " of ", totalItems), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
     size: "small",
@@ -109,9 +106,6 @@ var DxcPaginator = function DxcPaginator(_ref) {
     },
     value: currentPage.toString(),
     size: "fillParent",
-    margin: {
-      top: "xsmall"
-    },
     tabIndex: tabIndex
   }))) || /*#__PURE__*/_react["default"].createElement(TextContainer, null, "Page: ", currentPageInternal, " of ", totalPages), onPageChange && /*#__PURE__*/_react["default"].createElement(_Button["default"], {
     size: "small",

package/paginator/Paginator.stories.tsx

@@ -0,0 +1,63 @@
+import React from "react";
+import DxcPaginator from "./Paginator";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "Paginator",
+  component: DxcPaginator,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Default" theme="light" level={4} />
+      <DxcPaginator />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Default with items per page options" theme="light" level={4} />
+      <DxcPaginator itemsPerPageOptions={[5, 10, 15]} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Default with show go to page selector" theme="light" level={4} />
+      <DxcPaginator showGoToPage />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in first page" theme="light" level={4} />
+      <DxcPaginator currentPage={1} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in middle page" theme="light" level={4} />
+      <DxcPaginator currentPage={2} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change in last page" theme="light" level={4} />
+      <DxcPaginator currentPage={3} itemsPerPage={10} totalItems={27} onPageChange={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change and items per page options" theme="light" level={4} />
+      <DxcPaginator
+        currentPage={1}
+        itemsPerPage={10}
+        totalItems={27}
+        onPageChange={() => {}}
+        itemsPerPageOptions={[5, 10, 15]}
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change and show go to page selector" theme="light" level={4} />
+      <DxcPaginator currentPage={1} itemsPerPage={10} totalItems={27} onPageChange={() => {}} showGoToPage />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Page change, show go to page and items per page selectors" theme="light" level={4} />
+      <DxcPaginator
+        currentPage={1}
+        itemsPerPage={10}
+        totalItems={27}
+        onPageChange={() => {}}
+        itemsPerPageOptions={[5, 10, 15]}
+        showGoToPage
+      />
+    </ExampleContainer>
+  </>
+);

package/paginator/Paginator.test.js

@@ -0,0 +1,266 @@
+"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 _Paginator = _interopRequireDefault(require("./Paginator"));
+
+describe("Paginator component tests", function () {
+  test("Paginator renders with default values", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], null)),
+        getByText = _render.getByText;
+
+    expect(getByText("1 to 1 of 1")).toBeTruthy();
+    expect(getByText("Page: 1 of 1")).toBeTruthy();
+  });
+  test("Paginator renders with currentPage", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 2
+    })),
+        getByText = _render2.getByText;
+
+    expect(getByText("Page: 2 of 1")).toBeTruthy();
+  });
+  test("Paginator renders with itemsPerPageOptions", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 1,
+      itemsPerPage: 10,
+      itemsPerPageOptions: [10, 15],
+      totalItems: 20
+    })),
+        getByText = _render3.getByText;
+
+    expect(getByText("Items per page")).toBeTruthy();
+  });
+  test("Paginator renders with itemsPerPageOptions", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getByText = _render4.getByText;
+
+    expect(getByText("1 to 10 of 20")).toBeTruthy();
+    expect(getByText("Page: 1 of 2")).toBeTruthy();
+  });
+  test("Paginator renders with totalItems", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      totalItems: 20
+    })),
+        getByText = _render5.getByText;
+
+    expect(getByText("1 to 5 of 20")).toBeTruthy();
+    expect(getByText("Page: 1 of 4")).toBeTruthy();
+  });
+  test("Paginator renders with correct text in second page", function () {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 2,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getByText = _render6.getByText;
+
+    expect(getByText("11 to 20 of 20")).toBeTruthy();
+    expect(getByText("Page: 2 of 2")).toBeTruthy();
+  });
+  test("Paginator renders goToPage select", function () {
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 2,
+      showGoToPage: true,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getByText = _render7.getByText;
+
+    expect(getByText("Go to page:")).toBeTruthy();
+  });
+  test("Paginator goToPage call correct function", function () {
+    var onClick = jest.fn();
+
+    window.HTMLElement.prototype.scrollIntoView = function () {};
+
+    window.HTMLElement.prototype.scrollTo = function () {};
+
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 27,
+      showGoToPage: true,
+      onPageChange: onClick
+    })),
+        getByText = _render8.getByText,
+        getAllByRole = _render8.getAllByRole,
+        getByRole = _render8.getByRole;
+
+    var goToPageSelect = getAllByRole("combobox")[0];
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(goToPageSelect);
+    });
+    var goToPageOption = getByText("2");
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(goToPageOption);
+    });
+    expect(onClick).toHaveBeenCalledWith(2);
+  });
+  test("Call correct goToPageFunction", function () {
+    var onClick = jest.fn();
+
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render9.getAllByRole;
+
+    var nextButton = getAllByRole("button")[2];
+
+    _userEvent["default"].click(nextButton);
+
+    expect(onClick).toHaveBeenCalled();
+  });
+  test("Call correct itemsPerPageFunction", function () {
+    var onClick = jest.fn();
+
+    window.HTMLElement.prototype.scrollIntoView = function () {};
+
+    window.HTMLElement.prototype.scrollTo = function () {};
+
+    var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      currentPage: 1,
+      itemsPerPage: 10,
+      itemsPerPageOptions: [10, 15],
+      itemsPerPageFunction: onClick,
+      totalItems: 20
+    })),
+        getAllByText = _render10.getAllByText,
+        getByText = _render10.getByText;
+
+    var select = getAllByText("10")[0];
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(select);
+    });
+    var itemPerPageOption = getByText("15");
+    (0, _react2.act)(function () {
+      _userEvent["default"].click(itemPerPageOption);
+    });
+    expect(onClick).toHaveBeenCalledWith(15);
+  });
+  test("Next button is disable in last page", function () {
+    var onClick = jest.fn();
+
+    var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 2,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render11.getAllByRole;
+
+    var nextButton = getAllByRole("button")[2];
+    expect(nextButton.hasAttribute("disabled")).toBeTruthy();
+
+    _userEvent["default"].click(nextButton);
+
+    expect(onClick).toHaveBeenCalledTimes(0);
+  });
+  test("Last button is disable in last page", function () {
+    var onClick = jest.fn();
+
+    var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 2,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render12.getAllByRole;
+
+    var lastButton = getAllByRole("button")[3];
+    expect(lastButton.hasAttribute("disabled")).toBeTruthy();
+
+    _userEvent["default"].click(lastButton);
+
+    expect(onClick).toHaveBeenCalledTimes(0);
+  });
+  test("First button is disable in first page", function () {
+    var onClick = jest.fn();
+
+    var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render13.getAllByRole;
+
+    var lastButton = getAllByRole("button")[0];
+    expect(lastButton.hasAttribute("disabled")).toBeTruthy();
+
+    _userEvent["default"].click(lastButton);
+
+    expect(onClick).toHaveBeenCalledTimes(0);
+  });
+  test("Previous button is disable in first page", function () {
+    var onClick = jest.fn();
+
+    var _render14 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render14.getAllByRole;
+
+    var lastButton = getAllByRole("button")[1];
+    expect(lastButton.hasAttribute("disabled")).toBeTruthy();
+
+    _userEvent["default"].click(lastButton);
+
+    expect(onClick).toHaveBeenCalledTimes(0);
+  });
+  test("Last and next buttons are disable in last page", function () {
+    var onClick = jest.fn();
+
+    var _render15 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 2,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render15.getAllByRole;
+
+    var firstButton = getAllByRole("button")[0];
+    var prevButton = getAllByRole("button")[1];
+    var nextButton = getAllByRole("button")[2];
+    var lastButton = getAllByRole("button")[3];
+    expect(firstButton.hasAttribute("disabled")).toBeFalsy();
+    expect(prevButton.hasAttribute("disabled")).toBeFalsy();
+    expect(nextButton.hasAttribute("disabled")).toBeTruthy();
+    expect(lastButton.hasAttribute("disabled")).toBeTruthy();
+  });
+  test("First and previous buttons are disable in first page", function () {
+    var onClick = jest.fn();
+
+    var _render16 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Paginator["default"], {
+      onPageChange: onClick,
+      currentPage: 1,
+      itemsPerPage: 10,
+      totalItems: 20
+    })),
+        getAllByRole = _render16.getAllByRole;
+
+    var firstButton = getAllByRole("button")[0];
+    var prevButton = getAllByRole("button")[1];
+    var nextButton = getAllByRole("button")[2];
+    var lastButton = getAllByRole("button")[3];
+    expect(firstButton.hasAttribute("disabled")).toBeTruthy();
+    expect(prevButton.hasAttribute("disabled")).toBeTruthy();
+    expect(nextButton.hasAttribute("disabled")).toBeFalsy();
+    expect(lastButton.hasAttribute("disabled")).toBeFalsy();
+  });
+});

package/password-input/PasswordInput.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import PasswordInputPropsType from "./types";
+declare const DxcPasswordInput: React.ForwardRefExoticComponent<PasswordInputPropsType & React.RefAttributes<HTMLDivElement>>;
+export default DxcPasswordInput;