@dxc-technology/halstack-react 0.0.0-a062293 → 0.0.0-a0fadb7

package/box/Box.stories.tsx

@@ -2,109 +2,88 @@ import React from "react";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
 import DxcBox from "./Box";
+import DxcInset from "../inset/Inset";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Box ",
   component: DxcBox,
 };
 
+const opinionatedTheme = {
+  box: {
+    baseColor: "#ffffff",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <Title title="Display flex" theme="light" level={2} />
     <ExampleContainer>
-      <DxcBox display="flex" padding="medium">
-        Box
+      <DxcBox display="flex">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <Title title="ShadowDepth" theme="light" level={2} />
     <ExampleContainer>
       <Title title="ShadowDepth 0" theme="light" level={4} />
-      <DxcBox shadowDepth={0} margin="medium" padding="medium">
-        Box
+      <DxcBox shadowDepth={0} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="ShadowDepth 1" theme="light" level={4} />
-      <DxcBox shadowDepth={1} margin="medium" padding="medium">
-        Box
+      <DxcBox shadowDepth={1} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="ShadowDepth 2" theme="light" level={4} />
-      <DxcBox shadowDepth={2} margin="medium" padding="medium">
-        Box
+      <DxcBox shadowDepth={2} margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
-    <Title title="Paddings" theme="light" level={2} />
-    <ExampleContainer>
-      <Title title="Xxsmall padding" theme="light" level={4} />
-      <DxcBox padding="xxsmall">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Xsmall padding" theme="light" level={4} />
-      <DxcBox padding="xsmall">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Small padding" theme="light" level={4} />
-      <DxcBox padding="small">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Medium padding" theme="light" level={4} />
-      <DxcBox padding="medium">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Large padding" theme="light" level={4} />
-      <DxcBox padding="large">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Xlarge padding" theme="light" level={4} />
-      <DxcBox padding="xlarge">Box</DxcBox>
-    </ExampleContainer>
-    <ExampleContainer>
-      <Title title="Xxlarge padding" theme="light" level={4} />
-      <DxcBox padding="xxlarge">Box</DxcBox>
-    </ExampleContainer>
     <Title title="Margins" theme="light" level={2} />
     <ExampleContainer>
       <Title title="Xxsmall margin" theme="light" level={4} />
-      <DxcBox margin="xxsmall" padding="medium">
-        Box
+      <DxcBox margin="xxsmall">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xsmall margin" theme="light" level={4} />
-      <DxcBox margin="xsmall" padding="medium">
-        Box
+      <DxcBox margin="xsmall">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Small margin" theme="light" level={4} />
-      <DxcBox margin="small" padding="medium">
-        Box
+      <DxcBox margin="small">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Medium margin" theme="light" level={4} />
-      <DxcBox margin="medium" padding="medium">
-        Box
+      <DxcBox margin="medium">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Large margin" theme="light" level={4} />
-      <DxcBox margin="large" padding="medium">
-        Box
+      <DxcBox margin="large">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xlarge margin" theme="light" level={4} />
-      <DxcBox margin="xlarge" padding="medium">
-        Box
+      <DxcBox margin="xlarge">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <ExampleContainer>
       <Title title="Xxlarge margin" theme="light" level={4} />
-      <DxcBox margin="xxlarge" padding="medium">
-        Box
+      <DxcBox margin="xxlarge">
+        <DxcInset space="2rem">Box</DxcInset>
       </DxcBox>
     </ExampleContainer>
     <Title title="Sizes" theme="light" level={2} />
@@ -128,5 +107,13 @@ export const Chromatic = () => (
       <Title title="FitContent" theme="light" level={4} />
       <DxcBox size="fitContent">Box</DxcBox>
     </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcBox display="flex">
+          <DxcInset space="2rem">Box</DxcInset>
+        </DxcBox>
+      </HalstackProvider>
+    </ExampleContainer>
   </>
 );

package/box/Box.test.d.ts

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

package/box/Box.test.js

@@ -1,18 +1,13 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@testing-library/react");
-
 var _Card = _interopRequireDefault(require("../card/Card"));
-
 describe("Box component tests", function () {
   test("Box renders with correct text", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], null, "test-box")),
-        getByText = _render.getByText;
-
+      getByText = _render.getByText;
     expect(getByText("test-box")).toBeTruthy();
   });
 });

package/box/types.d.ts

@@ -1,18 +1,12 @@
 /// <reference types="react" />
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type Padding = {
-    top?: Space;
-    bottom?: Space;
-    left?: Space;
-    right?: Space;
-};
-declare type Props = {
+type Props = {
     /**
      * The size of the shadow to be displayed around the box.
      */
@@ -30,12 +24,6 @@ declare type Props = {
      * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different margin sizes.
      */
     margin?: Space | Margin;
-    /**
-     * @deprecated This prop will be removed shortly, consider using the Inset component for this purpose.
-     * Size of the padding to be applied to the custom area ('xxsmall' | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | 'xxlarge').
-     * You can pass an object with 'top', 'bottom', 'left' and 'right' properties in order to specify different padding sizes.
-     */
-    padding?: Space | Padding;
     /**
      * Size of the component.
      */

package/breadcrumbs/Breadcrumbs.accessibility.test.d.ts

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

package/breadcrumbs/Breadcrumbs.accessibility.test.js

@@ -0,0 +1,96 @@
+"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 _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _axeHelper = require("../../test/accessibility/axe-helper.js");
+var _Breadcrumbs = _interopRequireDefault(require("./Breadcrumbs"));
+var _disabledRules = require("../../test/accessibility/rules/specific/breadcrumbs/disabledRules.js");
+var disabledRules = {
+  rules: _disabledRules.disabledRules.reduce(function (rulesObj, rule) {
+    rulesObj[rule] = {
+      enabled: false
+    };
+    return rulesObj;
+  }, {})
+};
+var items = [{
+  label: "Home",
+  href: "/"
+}, {
+  label: "User Menu",
+  href: ""
+}, {
+  label: "Preferences",
+  href: ""
+}, {
+  label: "Dark Mode",
+  href: ""
+}];
+describe("Breadcrumbs component accessibility tests", function () {
+  it("Should not have basic accessibility issues", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var _render, container, results;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            ariaLabel: "example"
+          })), container = _render.container;
+          _context.next = 3;
+          return (0, _axeHelper.axe)(container, disabledRules);
+        case 3:
+          results = _context.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  it("Should not have basic accessibility issues when collapsed", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+    var _render2, container, results;
+    return _regenerator["default"].wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            itemsBeforeCollapse: 3,
+            ariaLabel: "example"
+          })), container = _render2.container;
+          _context2.next = 3;
+          return (0, _axeHelper.axe)(container, disabledRules);
+        case 3:
+          results = _context2.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+  it("Should not have basic accessibility issues without root", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
+    var _render3, container, results;
+    return _regenerator["default"].wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Breadcrumbs["default"], {
+            items: items,
+            itemsBeforeCollapse: 3,
+            ariaLabel: "example",
+            showRoot: false
+          })), container = _render3.container;
+          _context3.next = 3;
+          return (0, _axeHelper.axe)(container, disabledRules);
+        case 3:
+          results = _context3.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  })));
+});

package/breadcrumbs/Breadcrumbs.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import BreadcrumbsProps from "./types";
+declare const DxcBreadcrumbs: ({ ariaLabel, items, itemsBeforeCollapse, onItemClick, showRoot, }: BreadcrumbsProps) => React.JSX.Element;
+export default DxcBreadcrumbs;

package/breadcrumbs/Breadcrumbs.js

@@ -0,0 +1,79 @@
+"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 _Dropdown = _interopRequireDefault(require("../dropdown/Dropdown"));
+var _HalstackContext = require("../HalstackContext");
+var _dropdownTheme = _interopRequireDefault(require("./dropdownTheme"));
+var _coreTokens = _interopRequireDefault(require("../common/coreTokens"));
+var _Icon = _interopRequireDefault(require("../icon/Icon"));
+var _Item = _interopRequireDefault(require("./Item"));
+var _Flex = _interopRequireDefault(require("../flex/Flex"));
+var _templateObject;
+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 DxcBreadcrumbs = function DxcBreadcrumbs(_ref) {
+  var _ref$ariaLabel = _ref.ariaLabel,
+    ariaLabel = _ref$ariaLabel === void 0 ? "Breadcrumbs" : _ref$ariaLabel,
+    items = _ref.items,
+    _ref$itemsBeforeColla = _ref.itemsBeforeCollapse,
+    itemsBeforeCollapse = _ref$itemsBeforeColla === void 0 ? 4 : _ref$itemsBeforeColla,
+    onItemClick = _ref.onItemClick,
+    _ref$showRoot = _ref.showRoot,
+    showRoot = _ref$showRoot === void 0 ? true : _ref$showRoot;
+  var handleOnSelectOption = (0, _react.useCallback)(function (href) {
+    if (onItemClick) onItemClick(href);else window.location.href = href;
+  }, [items]);
+  return /*#__PURE__*/_react["default"].createElement("nav", {
+    "aria-label": ariaLabel
+  }, /*#__PURE__*/_react["default"].createElement(OrderedList, null, items && items.length > Math.max(itemsBeforeCollapse, 2) ? /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, showRoot && /*#__PURE__*/_react["default"].createElement(_Item["default"], {
+    href: items[0].href,
+    key: 0,
+    label: items[0].label
+  }), /*#__PURE__*/_react["default"].createElement(_Flex["default"], {
+    alignItems: "center",
+    as: "li",
+    key: 1
+  }, /*#__PURE__*/_react["default"].createElement(_HalstackContext.HalstackProvider, {
+    advancedTheme: _dropdownTheme["default"]
+  }, /*#__PURE__*/_react["default"].createElement(_Dropdown["default"], {
+    caretHidden: true,
+    icon: /*#__PURE__*/_react["default"].createElement(_Icon["default"], {
+      icon: "more_horiz"
+    }),
+    margin: showRoot && {
+      left: "small"
+    },
+    onSelectOption: handleOnSelectOption,
+    options: items.slice(showRoot ? 1 : 0, -1).map(function (_ref2) {
+      var label = _ref2.label,
+        href = _ref2.href;
+      return {
+        label: label,
+        value: href
+      };
+    })
+  }))), /*#__PURE__*/_react["default"].createElement(_Item["default"], {
+    isCurrentPage: true,
+    key: 2,
+    label: items[items.length - 1].label
+  })) : items.map(function (item, index, _ref3) {
+    var length = _ref3.length;
+    return /*#__PURE__*/_react["default"].createElement(_Item["default"], {
+      href: item.href,
+      isCurrentPage: index === length - 1,
+      key: index,
+      label: item.label,
+      onClick: onItemClick
+    });
+  })));
+};
+var OrderedList = _styledComponents["default"].ol(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  margin: ", ";\n  padding-left: ", ";\n  display: flex;\n  align-items: center;\n  gap: ", ";\n  list-style-type: none;\n\n  > li:not(:first-child) {\n    > a,\n    > span {\n      margin-left: ", ";\n    }\n    &::before {\n      margin: ", " ", ";\n      transform: rotate(15deg);\n      border-right: ", " solid ", ";\n      height: 1rem;\n      content: \"\";\n    }\n  }\n"])), _coreTokens["default"].spacing_0, _coreTokens["default"].spacing_0, _coreTokens["default"].spacing_12, _coreTokens["default"].spacing_12, _coreTokens["default"].spacing_0, _coreTokens["default"].spacing_2, _coreTokens["default"].border_width_1, _coreTokens["default"].color_grey_500);
+var _default = exports["default"] = DxcBreadcrumbs;

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 {};