@dxc-technology/halstack-react 0.0.0-d30020b → 0.0.0-d3624d0

package/breadcrumbs/Breadcrumbs.stories.tsx

@@ -0,0 +1,194 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcBreadcrumbs from "./Breadcrumbs";
+import DxcContainer from "../container/Container";
+import { HalstackProvider } from "../HalstackContext";
+import { userEvent, within } from "@storybook/testing-library";
+import { disabledRules } from "../../test/accessibility/rules/specific/breadcrumbs/disabledRules";
+import preview from "../../.storybook/preview";
+
+export default {
+  title: "Breadcrumbs",
+  component: DxcBreadcrumbs,
+  parameters: {
+    a11y: {
+      config: {
+        rules: [
+          ...disabledRules.map((ruleId) => ({ id: ruleId, enabled: false })),
+          ...preview?.parameters?.a11y?.config?.rules,
+        ],
+      },
+    },
+  },
+};
+
+const items = [
+  {
+    label: "Home",
+    href: "/",
+  },
+  {
+    label: "User Menu",
+    href: "",
+  },
+  {
+    label: "Preferences",
+    href: "",
+  },
+  {
+    label: "Customization",
+    href: "",
+  },
+  {
+    label: "Dark Mode",
+    href: "",
+  },
+];
+
+const Breadcrumbs = () => (
+  <>
+    <Title title="Default" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcBreadcrumbs
+        items={[
+          {
+            label: "Home",
+            href: "/",
+          },
+          {
+            label: "User Menu",
+            href: "",
+          },
+          {
+            label: "Preferences",
+            href: "",
+          },
+          {
+            label: "Dark Mode",
+            href: "",
+          },
+        ]}
+      />
+    </ExampleContainer>
+    <Title title="Collapsed variant" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcBreadcrumbs items={items} />
+    </ExampleContainer>
+    <Title title="Collapsed variant without root" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcBreadcrumbs items={items} showRoot={false} />
+    </ExampleContainer>
+    <Title title="Collapsed variant with dropdown menu opened" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcContainer height="150px">
+        <DxcBreadcrumbs items={items} />
+      </DxcContainer>
+    </ExampleContainer>
+    <Title title="Focus state" theme="light" level={3} />
+    <ExampleContainer pseudoState="pseudo-focus">
+      <DxcBreadcrumbs items={items} />
+    </ExampleContainer>
+    <Title title="Hover state" theme="light" level={3} />
+    <ExampleContainer pseudoState="pseudo-hover">
+      <DxcBreadcrumbs items={items} />
+    </ExampleContainer>
+    <Title title="Active state" theme="light" level={3} />
+    <ExampleContainer pseudoState="pseudo-active">
+      <DxcBreadcrumbs items={items} />
+    </ExampleContainer>
+    <Title title="Truncation and text ellipsis with tooltip (only when collapsed)" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcContainer width="200px">
+        <DxcBreadcrumbs
+          items={[
+            {
+              label: "Root",
+              href: "/",
+            },
+            {
+              label: "Main folder",
+              href: "",
+            },
+            {
+              label: "User",
+              href: "",
+            },
+            {
+              label: "Very long label for the link",
+              href: "",
+            },
+          ]}
+          itemsBeforeCollapse={3}
+        />
+      </DxcContainer>
+    </ExampleContainer>
+    <Title title="Truncation, text ellipsis with tooltip and without root" theme="light" level={3} />
+    <ExampleContainer>
+      <DxcContainer width="200px">
+        <DxcBreadcrumbs
+          items={[
+            {
+              label: "Root",
+              href: "/",
+            },
+            {
+              label: "Main folder",
+              href: "",
+            },
+            {
+              label: "User",
+              href: "",
+            },
+            {
+              label: "Very long label for the link",
+              href: "",
+            },
+          ]}
+          itemsBeforeCollapse={3}
+          showRoot={false}
+        />
+      </DxcContainer>
+    </ExampleContainer>
+    <Title title="Dropdown theming doesn't affect the collapsed trigger" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Opinionated theming" theme="light" level={4} />
+      <ExampleContainer>
+        <HalstackProvider
+          theme={{
+            dropdown: {
+              baseColor: "#fabada",
+              fontColor: "#999",
+              optionFontColor: "#4d4d4d",
+            },
+          }}
+        >
+          <DxcBreadcrumbs items={items} itemsBeforeCollapse={3} />
+        </HalstackProvider>
+      </ExampleContainer>
+      <Title title="Advanced theming" theme="light" level={4} />
+      <ExampleContainer>
+        <HalstackProvider
+          advancedTheme={{
+            dropdown: {
+              buttonBackgroundColor: "#fabada",
+              buttonHeight: "100px",
+              buttonBorderThickness: "2px",
+              buttonBorderStyle: "solid",
+              buttonBorderColor: "#000",
+            },
+          }}
+        >
+          <DxcBreadcrumbs items={items} itemsBeforeCollapse={3} />
+        </HalstackProvider>
+      </ExampleContainer>
+    </ExampleContainer>
+  </>
+);
+
+export const Chromatic = Breadcrumbs.bind({});
+Chromatic.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const dropdowns = canvas.getAllByRole("button");
+  await userEvent.click(dropdowns[2]);
+};

package/breadcrumbs/Breadcrumbs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/breadcrumbs/Breadcrumbs.test.js

@@ -0,0 +1,169 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _Breadcrumbs = _interopRequireDefault(require("./Breadcrumbs"));
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+global.ResizeObserver = /*#__PURE__*/function () {
+  function ResizeObserver() {
+    (0, _classCallCheck2["default"])(this, ResizeObserver);
+  }
+  (0, _createClass2["default"])(ResizeObserver, [{
+    key: "observe",
+    value: function observe() {}
+  }, {
+    key: "unobserve",
+    value: function unobserve() {}
+  }, {
+    key: "disconnect",
+    value: function disconnect() {}
+  }]);
+  return ResizeObserver;
+}();
+var items = [{
+  label: "Home",
+  href: "/"
+}, {
+  label: "User Menu",
+  href: ""
+}, {
+  label: "Preferences",
+  href: ""
+}, {
+  label: "Dark Mode",
+  href: ""
+}];
+describe("Breadcrumbs component tests", function () {
+  test("Renders with correct aria accessibility attributes", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+        items: items,
+        ariaLabel: "example"
+      })),
+      getByText = _render.getByText,
+      getByRole = _render.getByRole;
+    var breadcrumbs = getByRole("navigation");
+    expect(breadcrumbs.getAttribute("aria-label")).toBe("example");
+    expect(getByText("Dark Mode").parentElement.getAttribute("aria-current")).toBe("page");
+  });
+  test("Collapsed variant renders all the items inside the dropdown menu except the root and the current page", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var _render2, queryByText, getByText, getByRole, dropdown;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            itemsBeforeCollapse: 3
+          })), queryByText = _render2.queryByText, getByText = _render2.getByText, getByRole = _render2.getByRole;
+          dropdown = getByRole("button");
+          expect(queryByText("User Menu")).toBeFalsy();
+          expect(queryByText("Preferences")).toBeFalsy();
+          _context.next = 6;
+          return _userEvent["default"].click(dropdown);
+        case 6:
+          expect(getByText("User Menu")).toBeTruthy();
+          expect(getByText("Preferences")).toBeTruthy();
+        case 8:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  test("Collapsed variant, with show root set to false, renders all the items inside the dropdown menu except the current page", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+    var _render3, queryByText, getByText, getByRole, dropdown;
+    return _regenerator["default"].wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            itemsBeforeCollapse: 3,
+            showRoot: false
+          })), queryByText = _render3.queryByText, getByText = _render3.getByText, getByRole = _render3.getByRole;
+          dropdown = getByRole("button");
+          expect(queryByText("Home")).toBeFalsy();
+          expect(queryByText("User Menu")).toBeFalsy();
+          expect(queryByText("Preferences")).toBeFalsy();
+          _context2.next = 7;
+          return _userEvent["default"].click(dropdown);
+        case 7:
+          expect(getByText("Home")).toBeTruthy();
+          expect(getByText("User Menu")).toBeTruthy();
+          expect(getByText("Preferences")).toBeTruthy();
+        case 10:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+  test("If itemsBeforeCollapse value is below two, ignores it and renders a collapsed variant", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
+    var _render4, getByText, getByRole;
+    return _regenerator["default"].wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            itemsBeforeCollapse: -1
+          })), getByText = _render4.getByText, getByRole = _render4.getByRole;
+          expect(getByText("Home")).toBeTruthy();
+          expect(getByRole("button")).toBeTruthy();
+          expect(getByText("Dark Mode")).toBeTruthy();
+        case 4:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  })));
+  test("The onClick prop from an item is properly called", function () {
+    var onItemClick = jest.fn();
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+        onItemClick: onItemClick,
+        items: [{
+          label: "Home",
+          href: "/home"
+        }, {
+          label: "Preferences",
+          href: "/preferences"
+        }]
+      })),
+      getByText = _render5.getByText;
+    _userEvent["default"].click(getByText("Home"));
+    expect(onItemClick).toHaveBeenCalledWith("/home");
+  });
+  test("The onClick prop from an item is properly called (collapsed)", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4() {
+    var onItemClick, _render6, getByText, getByRole;
+    return _regenerator["default"].wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          onItemClick = jest.fn();
+          _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            onItemClick: onItemClick,
+            items: [{
+              label: "Home",
+              href: "/"
+            }, {
+              label: "Preferences",
+              href: "/"
+            }, {
+              label: "Dark Mode",
+              href: "/"
+            }],
+            itemsBeforeCollapse: 2
+          })), getByText = _render6.getByText, getByRole = _render6.getByRole;
+          _context4.next = 4;
+          return _userEvent["default"].click(getByRole("button"));
+        case 4:
+          _context4.next = 6;
+          return _userEvent["default"].click(getByText("Preferences"));
+        case 6:
+          expect(onItemClick).toHaveBeenCalledWith("/");
+        case 7:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  })));
+});

package/breadcrumbs/Item.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { ItemPropsType } from "./types";
+declare const Item: ({ isCurrentPage, href, label, onClick }: ItemPropsType) => React.JSX.Element;
+export default Item;

package/breadcrumbs/Item.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _react = _interopRequireWildcard(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _coreTokens = _interopRequireDefault(require("../common/coreTokens"));
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
+var Item = function Item(_ref) {
+  var _ref$isCurrentPage = _ref.isCurrentPage,
+    isCurrentPage = _ref$isCurrentPage === void 0 ? false : _ref$isCurrentPage,
+    href = _ref.href,
+    label = _ref.label,
+    onClick = _ref.onClick;
+  var currentItemRef = (0, _react.useRef)(null);
+  var handleOnMouseEnter = function handleOnMouseEnter(event) {
+    var labelContainer = event.currentTarget;
+    var optionElement = currentItemRef === null || currentItemRef === void 0 ? void 0 : currentItemRef.current;
+    if (optionElement.title === "" && labelContainer.scrollWidth > labelContainer.clientWidth) optionElement.title = label;
+  };
+  var handleOnClick = function handleOnClick(event) {
+    if (onClick) {
+      event.preventDefault();
+      onClick(href);
+    }
+  };
+  return /*#__PURE__*/_react["default"].createElement(ListItem, {
+    "aria-current": isCurrentPage ? "page" : undefined,
+    isCurrentPage: isCurrentPage
+  }, isCurrentPage ? /*#__PURE__*/_react["default"].createElement(CurrentPage, {
+    ref: currentItemRef,
+    onMouseEnter: handleOnMouseEnter
+  }, label) : /*#__PURE__*/_react["default"].createElement(Link, {
+    href: href,
+    onClick: handleOnClick
+  }, /*#__PURE__*/_react["default"].createElement(Text, null, label)));
+};
+var ListItem = _styledComponents["default"].li(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  align-items: center;\n  font-family: ", ";\n  font-size: ", ";\n  color: ", ";\n  ", "\n"])), _coreTokens["default"].type_sans, _coreTokens["default"].type_scale_02, _coreTokens["default"].color_black, function (_ref2) {
+  var isCurrentPage = _ref2.isCurrentPage;
+  return isCurrentPage && "overflow: hidden;";
+});
+var CurrentPage = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  font-weight: ", ";\n  overflow: hidden;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  cursor: default;\n"])), _coreTokens["default"].type_semibold);
+var Link = _styledComponents["default"].a(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  border-radius: ", ";\n  padding: ", " ", ";\n  display: inline-flex;\n  align-items: center;\n  height: 24px;\n  color: ", ";\n  text-decoration: ", ";\n  cursor: pointer;\n\n  &:focus {\n    outline: ", " solid ", ";\n  }\n"])), _coreTokens["default"].border_radius_small, _coreTokens["default"].spacing_0, _coreTokens["default"].spacing_2, _coreTokens["default"].color_black, _coreTokens["default"].type_no_line, _coreTokens["default"].border_width_2, _coreTokens["default"].color_blue_600);
+var Text = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  border: ", " solid ", ";\n  &:hover {\n    border-bottom-color: ", ";\n  }\n"])), _coreTokens["default"].border_width_1, _coreTokens["default"].color_transparent, _coreTokens["default"].color_black);
+var _default = exports["default"] = Item;

package/breadcrumbs/dropdownTheme.d.ts

@@ -0,0 +1,53 @@
+declare const _default: {
+    dropdown: {
+        buttonIconSize: string;
+        buttonPaddingTop: string;
+        buttonPaddingBottom: string;
+        buttonPaddingLeft: string;
+        buttonPaddingRight: string;
+        buttonHeight: string;
+        buttonBorderRadius: string;
+        buttonBorderColor: string;
+        optionFontSize: string;
+        optionPaddingTop: string;
+        optionPaddingBottom: string;
+        optionPaddingLeft: string;
+        optionPaddingRight: string;
+        buttonBackgroundColor: string;
+        hoverButtonBackgroundColor: string;
+        activeButtonBackgroundColor: string;
+        buttonFontFamily: string;
+        buttonFontSize: string;
+        buttonFontStyle: string;
+        buttonFontWeight: string;
+        buttonFontColor: string;
+        buttonIconSpacing: string;
+        buttonIconColor: string;
+        buttonBorderStyle: string;
+        buttonBorderThickness: string;
+        disabledColor: string;
+        disabledButtonBackgroundColor: string;
+        disabledButtonBorderColor: string;
+        optionBackgroundColor: string;
+        hoverOptionBackgroundColor: string;
+        activeOptionBackgroundColor: string;
+        optionFontFamily: string;
+        optionFontStyle: string;
+        optionFontWeight: string;
+        optionFontColor: string;
+        optionIconSize: string;
+        optionIconSpacing: string;
+        optionIconColor: string;
+        caretIconSize: string;
+        caretIconColor: string;
+        caretIconSpacing: string;
+        borderRadius: string;
+        borderStyle: string;
+        borderThickness: string;
+        borderColor: string;
+        scrollBarThumbColor: string;
+        scrollBarTrackColor: string;
+        focusColor: string;
+    };
+};
+export default _default;

package/breadcrumbs/dropdownTheme.js

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _coreTokens = _interopRequireDefault(require("../common/coreTokens"));
+var _default = exports["default"] = {
+  dropdown: {
+    // Breadcrumbs tokens
+    buttonIconSize: _coreTokens["default"].spacing_16,
+    buttonPaddingTop: _coreTokens["default"].spacing_4,
+    buttonPaddingBottom: _coreTokens["default"].spacing_4,
+    buttonPaddingLeft: _coreTokens["default"].spacing_4,
+    buttonPaddingRight: _coreTokens["default"].spacing_4,
+    buttonHeight: "24px",
+    buttonBorderRadius: "2px",
+    buttonBorderColor: _coreTokens["default"].color_transparent,
+    optionFontSize: "14px",
+    optionPaddingTop: _coreTokens["default"].spacing_0,
+    optionPaddingBottom: _coreTokens["default"].spacing_0,
+    optionPaddingLeft: _coreTokens["default"].spacing_16,
+    optionPaddingRight: _coreTokens["default"].spacing_16,
+    // Dropdown tokens
+    buttonBackgroundColor: _coreTokens["default"].color_white,
+    hoverButtonBackgroundColor: _coreTokens["default"].color_grey_100,
+    activeButtonBackgroundColor: _coreTokens["default"].color_grey_300,
+    buttonFontFamily: _coreTokens["default"].type_sans,
+    buttonFontSize: _coreTokens["default"].type_scale_03,
+    buttonFontStyle: _coreTokens["default"].type_normal,
+    buttonFontWeight: _coreTokens["default"].type_regular,
+    buttonFontColor: _coreTokens["default"].color_black,
+    buttonIconSpacing: "10px",
+    buttonIconColor: _coreTokens["default"].color_black,
+    buttonBorderStyle: _coreTokens["default"].border_none,
+    buttonBorderThickness: _coreTokens["default"].border_width_0,
+    disabledColor: _coreTokens["default"].color_grey_500,
+    disabledButtonBackgroundColor: _coreTokens["default"].color_transparent,
+    disabledButtonBorderColor: _coreTokens["default"].color_transparent,
+    optionBackgroundColor: _coreTokens["default"].color_white,
+    hoverOptionBackgroundColor: _coreTokens["default"].color_grey_100,
+    activeOptionBackgroundColor: _coreTokens["default"].color_grey_300,
+    optionFontFamily: _coreTokens["default"].type_sans,
+    optionFontStyle: _coreTokens["default"].type_normal,
+    optionFontWeight: _coreTokens["default"].type_regular,
+    optionFontColor: _coreTokens["default"].color_black,
+    optionIconSize: "20px",
+    optionIconSpacing: "10px",
+    optionIconColor: _coreTokens["default"].color_black,
+    caretIconSize: "24px",
+    caretIconColor: _coreTokens["default"].color_black,
+    caretIconSpacing: "12px",
+    borderRadius: "4px",
+    borderStyle: _coreTokens["default"].border_none,
+    borderThickness: _coreTokens["default"].border_width_0,
+    borderColor: _coreTokens["default"].color_transparent,
+    scrollBarThumbColor: _coreTokens["default"].color_grey_700,
+    scrollBarTrackColor: _coreTokens["default"].color_grey_300,
+    focusColor: _coreTokens["default"].color_blue_600
+  }
+};

package/breadcrumbs/types.d.ts

@@ -0,0 +1,16 @@
+type Item = {
+    href?: string;
+    label: string;
+};
+type Props = {
+    ariaLabel?: string;
+    items: Item[];
+    itemsBeforeCollapse?: number;
+    onItemClick?: (href: string) => void;
+    showRoot?: boolean;
+};
+export type ItemPropsType = Item & {
+    isCurrentPage?: boolean;
+    onClick?: (href: string) => void;
+};
+export default Props;