@dxc-technology/halstack-react 0.0.0-5908eb4 → 0.0.0-5aa300b

package/tabs/Tabs.test.js

@@ -0,0 +1,351 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Tabs = _interopRequireDefault(require("./Tabs"));
+
+var sampleTabs = [{
+  label: "Tab-1"
+}, {
+  label: "Tab-2"
+}, {
+  label: "Tab-3"
+}];
+var sampleTabsWithBadge = [{
+  label: "Tab-1",
+  notificationNumber: "10"
+}, {
+  label: "Tab-2",
+  notificationNumber: "20"
+}, {
+  label: "Tab-3",
+  notificationNumber: "101"
+}];
+var sampleTabsMiddleDisabled = [{
+  label: "Tab-1"
+}, {
+  label: "Tab-2",
+  isDisabled: true
+}, {
+  label: "Tab-3"
+}];
+var sampleTabsLastTabNonDisabled = [{
+  label: "Tab-1",
+  isDisabled: true
+}, {
+  label: "Tab-2",
+  isDisabled: true
+}, {
+  label: "Tab-3"
+}];
+describe("Tabs component tests", function () {
+  test("Tabs render with correct labels", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabs
+    })),
+        getByText = _render.getByText,
+        getAllByRole = _render.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+    expect(getByText("Tab-1")).toBeTruthy();
+    expect(getByText("Tab-2")).toBeTruthy();
+    expect(getByText("Tab-3")).toBeTruthy();
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+  });
+  test("Tabs render with correct labels and badges", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabsWithBadge
+    })),
+        getByText = _render2.getByText;
+
+    expect(getByText("10")).toBeTruthy();
+    expect(getByText("20")).toBeTruthy();
+    expect(getByText("+99")).toBeTruthy();
+  });
+  test("Tabs render with an initially active tab", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      defaultActiveTabIndex: 2,
+      tabs: sampleTabsWithBadge
+    })),
+        getAllByRole = _render3.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("true");
+  });
+  test("Tabs render with correct icons", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: [{
+        label: "Tab-1",
+        icon: "/testIcon1.png"
+      }, {
+        label: "Tab-2",
+        icon: "/testIcon2.png"
+      }, {
+        label: "Tab-3",
+        icon: "/testIcon3.png"
+      }]
+    })),
+        getAllByRole = _render4.getAllByRole;
+
+    expect(getAllByRole("img")[0].getAttribute("src")).toBe("/testIcon1.png");
+    expect(getAllByRole("img")[1].getAttribute("src")).toBe("/testIcon2.png");
+    expect(getAllByRole("img")[2].getAttribute("src")).toBe("/testIcon3.png");
+  });
+  test("Tabs render with disabled tab", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: [{
+        label: "Tab-1",
+        isDisabled: true
+      }, {
+        label: "Tab-2"
+      }]
+    })),
+        getAllByRole = _render5.getAllByRole;
+
+    expect(getAllByRole("tab")[0].hasAttribute("disabled")).toBeTruthy();
+    expect(getAllByRole("tab")[1].hasAttribute("disabled")).toBeFalsy();
+  });
+  test("Uncontrolled tabs", function () {
+    var onTabClick = jest.fn();
+
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabs,
+      onTabClick: onTabClick
+    })),
+        getByText = _render6.getByText,
+        getAllByRole = _render6.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+    var tab1 = getByText("Tab-1");
+    var tab2 = getByText("Tab-2");
+
+    _react2.fireEvent.click(tab2);
+
+    expect(onTabClick).toHaveBeenCalledWith(1);
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+
+    _react2.fireEvent.click(tab1);
+
+    expect(onTabClick).toHaveBeenCalledWith(0);
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+  });
+  test("Controlled tabs", function () {
+    var onTabClick = jest.fn();
+
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabs,
+      onTabClick: onTabClick,
+      activeTabIndex: 0
+    })),
+        getByText = _render7.getByText,
+        getAllByRole = _render7.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+
+    _react2.fireEvent.click(tabs[1]);
+
+    expect(onTabClick).toHaveBeenCalledWith(1);
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+
+    _react2.fireEvent.click(tabs[2]);
+
+    expect(onTabClick).toHaveBeenCalledWith(2);
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+  });
+  test("Uncontrolled tabs should have focus in the first non-disabled tab", function () {
+    var onTabClick = jest.fn();
+
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabsLastTabNonDisabled,
+      onTabClick: onTabClick
+    })),
+        getAllByRole = _render8.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+    expect(tabs[0].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[1].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[2].hasAttribute("disabled")).toBeFalsy();
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("true");
+  });
+  test("Controlled tabs with active index in disabled tab should not change focus to the first available tab", function () {
+    var onTabClick = jest.fn();
+
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabsLastTabNonDisabled,
+      onTabClick: onTabClick,
+      activeTabIndex: 0
+    })),
+        getAllByRole = _render9.getAllByRole;
+
+    var tabs = getAllByRole("tab");
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[0].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[1].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[2].hasAttribute("disabled")).toBeFalsy();
+
+    _react2.fireEvent.click(tabs[2]);
+
+    expect(onTabClick).toHaveBeenCalledWith(2);
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[0].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[1].hasAttribute("disabled")).toBeTruthy();
+    expect(tabs[2].hasAttribute("disabled")).toBeFalsy();
+  });
+  test("Select tabs with keyboard event arrows", function () {
+    var onTabClick = jest.fn();
+
+    var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabs,
+      onTabClick: onTabClick
+    })),
+        getByText = _render10.getByText,
+        getByRole = _render10.getByRole,
+        getAllByRole = _render10.getAllByRole;
+
+    var tabList = getByRole("tablist");
+    var tab1 = getByText("Tab-1");
+    var tabs = getAllByRole("tab");
+
+    _react2.fireEvent.click(tab1);
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(0);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowRight"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(1);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowRight"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("true");
+    expect(onTabClick).toHaveBeenCalledWith(2);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowLeft"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(1);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowLeft"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(0);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowLeft"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("true");
+    expect(onTabClick).toHaveBeenCalledWith(2);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowRight"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "Enter"
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(0);
+  });
+  test("Skip disabled tab with keyboard event arrows", function () {
+    var onTabClick = jest.fn();
+
+    var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Tabs["default"], {
+      tabs: sampleTabsMiddleDisabled,
+      onTabClick: onTabClick
+    })),
+        getByText = _render11.getByText,
+        getByRole = _render11.getByRole,
+        getAllByRole = _render11.getAllByRole;
+
+    var tabList = getByRole("tablist");
+    var tab1 = getByText("Tab-1");
+    var tabs = getAllByRole("tab");
+
+    _react2.fireEvent.click(tab1);
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("true");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("false");
+    expect(onTabClick).toHaveBeenCalledWith(0);
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: "ArrowRight"
+    });
+
+    _react2.fireEvent.keyDown(tabList, {
+      key: " "
+    });
+
+    expect(tabs[0].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[1].getAttribute("aria-selected")).toBe("false");
+    expect(tabs[2].getAttribute("aria-selected")).toBe("true");
+    expect(onTabClick).toHaveBeenCalledWith(2);
+  });
+});

package/tabs/types.d.ts

@@ -0,0 +1,92 @@
+/// <reference types="react" />
+export declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+declare type TabCommonProps = {
+    /**
+     * Whether the tab is disabled or not.
+     */
+    isDisabled?: boolean;
+    /**
+     * If the value is 'true', an empty badge will appear.
+     * If it is 'false', no badge will appear.
+     * If a number is put it will be shown as the label of the notification
+     * in the tab, taking into account that if that number is greater than 99,
+     * it will appear as '+99' in the badge.
+     */
+    notificationNumber?: boolean | number;
+};
+export declare type TabLabelProps = TabCommonProps & {
+    /**
+     * Tab label.
+     */
+    label: string;
+    /**
+     * Element or path used as the icon that will be displayed in the tab.
+     */
+    icon?: string | SVG;
+};
+export declare type TabIconProps = TabCommonProps & {
+    /**
+     * Tab label.
+     */
+    label?: string;
+    /**
+     * Element or path used as the icon that will be displayed in the tab.
+     */
+    icon: string | SVG;
+};
+export declare type TabProps = {
+    tab: TabLabelProps | TabIconProps;
+    active: boolean;
+    tabIndex: number;
+    hasLabelAndIcon: boolean;
+    iconPosition: "top" | "left";
+    onClick: () => void;
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+};
+declare type Props = {
+    /**
+     * An array of objects representing the tabs.
+     */
+    tabs: (TabLabelProps | TabIconProps)[];
+    /**
+     * Whether the icon should appear above or to the left of the label.
+     */
+    iconPosition?: "top" | "left";
+    /**
+     * Initially active tab, only when it is uncontrolled.
+     */
+    defaultActiveTabIndex?: number;
+    /**
+     * The index of the active tab. If undefined, the component will be
+     * uncontrolled and the active tab will be managed internally by the component.
+     */
+    activeTabIndex?: number;
+    /**
+     * This function will be called when the user clicks on a tab. The index of the
+     * clicked tab will be passed as a parameter.
+     */
+    onTabClick?: (tabIndex: number) => void;
+    /**
+     * This function will be called when the user hovers a tab.The index of the
+     * hovered tab will be passed as a parameter.
+     */
+    onTabHover?: (tabIndex: number) => void;
+    /**
+     * 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;
+    /**
+     * Value of the tabindex for each tab.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/tabs/types.js

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

package/tabs-nav/NavTabs.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { NavTabsContextProps, NavTabsProps } from "./types";
+export declare const NavTabsContext: React.Context<NavTabsContextProps>;
+declare const DxcNavTabs: {
+    ({ iconPosition, tabIndex, children }: NavTabsProps): JSX.Element;
+    Tab: React.ForwardRefExoticComponent<import("./types").TabProps & React.RefAttributes<HTMLAnchorElement>>;
+};
+export default DxcNavTabs;

package/tabs-nav/NavTabs.js

@@ -0,0 +1,125 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.NavTabsContext = void 0;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _Tab = _interopRequireDefault(require("./Tab"));
+
+var _templateObject;
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var NavTabsContext = /*#__PURE__*/(0, _react.createContext)(null);
+exports.NavTabsContext = NavTabsContext;
+
+var getPropInChild = function getPropInChild(child, propName) {
+  return child.props ? child.props[propName] ? child.props[propName] : child.props.children ? getPropInChild(child.props.children, propName) : undefined : undefined;
+};
+
+var getLabelFromTab = function getLabelFromTab(child) {
+  if (typeof child === "string") {
+    return child.toString();
+  } else if (child.props.children) {
+    return Array.isArray(child.props.children) ? getLabelFromTab(child.props.children[0]) : getLabelFromTab(child.props.children);
+  }
+};
+
+var getPreviousTabIndex = function getPreviousTabIndex(array, initialIndex) {
+  var index = initialIndex === 0 ? array.length - 1 : initialIndex - 1;
+
+  while (getPropInChild(array[index], "disabled")) {
+    index = index === 0 ? array.length - 1 : index - 1;
+  }
+
+  return index;
+};
+
+var getNextTabIndex = function getNextTabIndex(array, initialIndex) {
+  var index = initialIndex === array.length - 1 ? 0 : initialIndex + 1;
+
+  while (getPropInChild(array[index], "disabled")) {
+    index = index === array.length - 1 ? 0 : index + 1;
+  }
+
+  return index;
+};
+
+var DxcNavTabs = function DxcNavTabs(_ref) {
+  var _ref$iconPosition = _ref.iconPosition,
+      iconPosition = _ref$iconPosition === void 0 ? "top" : _ref$iconPosition,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex,
+      children = _ref.children;
+  var colorsTheme = (0, _useTheme["default"])();
+
+  var _useState = (0, _react.useState)(null),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      innerFocus = _useState2[0],
+      setInnerFocus = _useState2[1];
+
+  var contextValue = (0, _react.useMemo)(function () {
+    return {
+      iconPosition: iconPosition,
+      tabIndex: tabIndex,
+      hasIcons: _react["default"].Children.toArray(children).some(function (child) {
+        return getPropInChild(child, "icon");
+      }),
+      focusedLabel: innerFocus === null ? undefined : getLabelFromTab(children[innerFocus])
+    };
+  }, [iconPosition, tabIndex, innerFocus]);
+
+  var handleOnKeyDown = function handleOnKeyDown(event) {
+    var activeTab = _react["default"].Children.toArray(children).findIndex(function (child) {
+      return getPropInChild(child, "active");
+    });
+
+    switch (event.key) {
+      case "Left":
+      case "ArrowLeft":
+        event.preventDefault();
+        setInnerFocus(getPreviousTabIndex(children, innerFocus === null ? activeTab : innerFocus));
+        break;
+
+      case "Right":
+      case "ArrowRight":
+        event.preventDefault();
+        setInnerFocus(getNextTabIndex(children, innerFocus === null ? activeTab : innerFocus));
+        break;
+    }
+  };
+
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.tabs
+  }, /*#__PURE__*/_react["default"].createElement(NavTabsContainer, {
+    onKeyDown: handleOnKeyDown,
+    role: "tablist",
+    "aria-label": "Navigation tabs"
+  }, /*#__PURE__*/_react["default"].createElement(NavTabsContext.Provider, {
+    value: contextValue
+  }, children)));
+};
+
+DxcNavTabs.Tab = _Tab["default"];
+
+var NavTabsContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n"])));
+
+var _default = DxcNavTabs;
+exports["default"] = _default;