@dxc-technology/halstack-react 0.0.0-2c3a5e1 → 0.0.0-2d5bb6f

package/tabs/Tabs.stories.tsx

@@ -1,8 +1,8 @@
 import React from "react";
-import { userEvent, within } from "@storybook/testing-library";
 import DxcTabs from "./Tabs";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Tabs",
@@ -10,9 +10,8 @@ export default {
 };
 
 const iconSVG = (
-  <svg viewBox="0 0 24 24" fill="currentColor">
-    <path d="M0 0h24v24H0z" fill="none" />
-    <path d="M12 21.35l-1.45-1.32C5.4 15.36 2 12.28 2 8.5 2 5.42 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.09C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.42 22 8.5c0 3.78-3.4 6.86-8.55 11.54L12 21.35z" />
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" height="20" width="20" fill="currentColor">
+    <path d="m10 17-1.042-.938q-2.083-1.854-3.437-3.177-1.354-1.323-2.136-2.354Q2.604 9.5 2.302 8.646 2 7.792 2 6.896q0-1.854 1.271-3.125T6.396 2.5q1.021 0 1.979.438.958.437 1.625 1.229.667-.792 1.625-1.229.958-.438 1.979-.438 1.854 0 3.125 1.271T18 6.896q0 .896-.292 1.729-.291.833-1.073 1.854-.781 1.021-2.145 2.365-1.365 1.344-3.49 3.26Zm0-2.021q1.938-1.729 3.188-2.948 1.25-1.219 1.989-2.125.74-.906 1.031-1.614.292-.709.292-1.396 0-1.229-.833-2.063Q14.833 4 13.604 4q-.729 0-1.364.302-.636.302-1.094.844L10.417 6h-.834l-.729-.854q-.458-.542-1.114-.844Q7.083 4 6.396 4q-1.229 0-2.063.833-.833.834-.833 2.063 0 .687.271 1.364.271.678.989 1.573.719.896 1.98 2.125Q8 13.188 10 14.979Zm0-5.5Z" />
   </svg>
 );
 
@@ -30,6 +29,44 @@ const tabs: any = [
   {
     label: "Tab 4",
   },
+  {
+    label: "Tab 5",
+  },
+  {
+    label: "Tab 6",
+  },
+  {
+    label: "Tab 7",
+  },
+];
+
+const disabledTabs: any = [
+  {
+    label: "Tab 1",
+    isDisabled: true,
+  },
+  {
+    label: "Tab 2",
+    isDisabled: true,
+  },
+  {
+    label: "Tab 3",
+    isDisabled: true,
+  },
+];
+
+const firstDisabledTabs: any = [
+  {
+    label: "Tab 1",
+    isDisabled: true,
+  },
+  {
+    label: "Tab 2",
+    isDisabled: true,
+  },
+  {
+    label: "Tab 3",
+  },
 ];
 
 const tabsNotification = tabs.map((tab, index) => ({
@@ -37,16 +74,34 @@ const tabsNotification = tabs.map((tab, index) => ({
   notificationNumber: (index === 0 && true) || (index === 1 && 5) || (index === 2 && 200),
 }));
 
-const tabsIcon = tabs.map((tab) => ({ ...tab, icon: iconSVG }));
+const tabsIcon = tabs.map((tab, index) =>
+  index <= tabs.length / 2
+    ? { ...tab, icon: "https://cdn-icons-png.flaticon.com/512/5039/5039041.png" }
+    : { ...tab, icon: iconSVG }
+);
 
 const tabsNotificationIcon = tabsNotification.map((tab) => ({ ...tab, icon: iconSVG }));
 
+const opinionatedTheme = {
+  tabs: {
+    baseColor: "#5f249f",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <ExampleContainer>
       <Title title="Only label" theme="light" level={4} />
       <DxcTabs tabs={tabs} />
     </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled tabs" theme="light" level={4} />
+      <DxcTabs activeTabIndex={0} tabs={disabledTabs} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="First two tabs disabled" theme="light" level={4} />
+      <DxcTabs tabs={firstDisabledTabs} />
+    </ExampleContainer>
     <ExampleContainer pseudoState="pseudo-hover">
       <Title title="Hovered tabs" theme="light" level={4} />
       <DxcTabs tabs={tabs} />
@@ -79,13 +134,6 @@ export const Chromatic = () => (
       <Title title="With icon on the left and notification number" theme="light" level={4} />
       <DxcTabs tabs={tabsNotificationIcon} iconPosition="left" />
     </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Scrollable" theme="light" level={4} />
-      <div style={{ width: "400px" }}>
-        <DxcTabs tabs={tabsNotificationIcon} iconPosition="left" activeTabIndex={1} />
-      </div>
-    </ExampleContainer>
-
     <Title title="Margins" theme="light" level={2} />
     <ExampleContainer>
       <Title title="Xxsmall margin" theme="light" level={4} />
@@ -114,7 +162,65 @@ export const Chromatic = () => (
     <ExampleContainer>
       <Title title="Xxlarge margin" theme="light" level={4} />
       <DxcTabs tabs={tabs} margin="xxlarge" />
-      <hr />
+    </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="With icon and notification" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTabs tabs={tabsNotificationIcon} />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Disabled" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTabs activeTabIndex={0} tabs={disabledTabs} />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTabs tabs={tabs} />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="Focused" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTabs tabs={tabs} />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-active">
+      <Title title="Actived" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcTabs tabs={tabs} />
+      </HalstackProvider>
+    </ExampleContainer>
+  </>
+);
+
+export const ScrollableTabs = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Only label" theme="light" level={4} />
+      <DxcTabs tabs={tabs} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="Hovered tabs" theme="light" level={4} />
+      <DxcTabs tabs={tabs} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="Focused tabs" theme="light" level={4} />
+      <DxcTabs tabs={tabs} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-active">
+      <Title title="Actived tabs" theme="light" level={4} />
+      <DxcTabs tabs={tabs} />
     </ExampleContainer>
   </>
 );
+
+ScrollableTabs.parameters = {
+  viewport: {
+    defaultViewport: "iphonex",
+  },
+  chromatic: { viewports: [375], delay: 5000 },
+};

package/tabs/Tabs.test.js

@@ -0,0 +1,295 @@
+"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

@@ -1,13 +1,13 @@
 /// <reference types="react" />
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+export type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type SVG = React.SVGProps<SVGSVGElement>;
-declare type TabCommonProps = {
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+type TabCommonProps = {
     /**
      * Whether the tab is disabled or not.
      */
@@ -21,7 +21,7 @@ declare type TabCommonProps = {
      */
     notificationNumber?: boolean | number;
 };
-declare type TabLabelProps = TabCommonProps & {
+export type TabLabelProps = TabCommonProps & {
     /**
      * Tab label.
      */
@@ -31,7 +31,7 @@ declare type TabLabelProps = TabCommonProps & {
      */
     icon?: string | SVG;
 };
-declare type TabIconProps = TabCommonProps & {
+export type TabIconProps = TabCommonProps & {
     /**
      * Tab label.
      */
@@ -41,7 +41,17 @@ declare type TabIconProps = TabCommonProps & {
      */
     icon: string | SVG;
 };
-declare type Props = {
+export type TabProps = {
+    tab: TabLabelProps | TabIconProps;
+    active: boolean;
+    tabIndex: number;
+    hasLabelAndIcon: boolean;
+    iconPosition: "top" | "left";
+    onClick: () => void;
+    onMouseEnter: () => void;
+    onMouseLeave: () => void;
+};
+type Props = {
     /**
      * An array of objects representing the tabs.
      */
@@ -50,6 +60,10 @@ declare type Props = {
      * 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.