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

package/heading/Heading.test.js

@@ -1,21 +1,16 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@testing-library/react");
-
-var _Heading = _interopRequireDefault(require("./Heading"));
-
+var _Heading = _interopRequireDefault(require("./Heading.tsx"));
 describe("Heading component tests", function () {
   test("Heading renders with default level", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test"
-    })),
-        getByText = _render.getByText,
-        getByRole = _render.getByRole;
-
+        text: "my-heading-test"
+      })),
+      getByText = _render.getByText,
+      getByRole = _render.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 1
@@ -23,12 +18,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 1", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 1
-    })),
-        getByText = _render2.getByText,
-        getByRole = _render2.getByRole;
-
+        text: "my-heading-test",
+        level: 1
+      })),
+      getByText = _render2.getByText,
+      getByRole = _render2.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 1
@@ -36,12 +30,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 2", function () {
     var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 2
-    })),
-        getByText = _render3.getByText,
-        getByRole = _render3.getByRole;
-
+        text: "my-heading-test",
+        level: 2
+      })),
+      getByText = _render3.getByText,
+      getByRole = _render3.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 2
@@ -49,12 +42,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 3", function () {
     var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 3
-    })),
-        getByText = _render4.getByText,
-        getByRole = _render4.getByRole;
-
+        text: "my-heading-test",
+        level: 3
+      })),
+      getByText = _render4.getByText,
+      getByRole = _render4.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 3
@@ -62,12 +54,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 4", function () {
     var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 4
-    })),
-        getByText = _render5.getByText,
-        getByRole = _render5.getByRole;
-
+        text: "my-heading-test",
+        level: 4
+      })),
+      getByText = _render5.getByText,
+      getByRole = _render5.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 4
@@ -75,12 +66,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 5", function () {
     var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 5
-    })),
-        getByText = _render6.getByText,
-        getByRole = _render6.getByRole;
-
+        text: "my-heading-test",
+        level: 5
+      })),
+      getByText = _render6.getByText,
+      getByRole = _render6.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 5
@@ -88,12 +78,11 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with default level and as h5", function () {
     var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      as: "h5"
-    })),
-        getByText = _render7.getByText,
-        getByRole = _render7.getByRole;
-
+        text: "my-heading-test",
+        as: "h5"
+      })),
+      getByText = _render7.getByText,
+      getByRole = _render7.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 5
@@ -101,13 +90,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 1 and as h5", function () {
     var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 1,
-      as: "h5"
-    })),
-        getByText = _render8.getByText,
-        getByRole = _render8.getByRole;
-
+        text: "my-heading-test",
+        level: 1,
+        as: "h5"
+      })),
+      getByText = _render8.getByText,
+      getByRole = _render8.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 5
@@ -115,13 +103,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 2 and as h4", function () {
     var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 2,
-      as: "h4"
-    })),
-        getByText = _render9.getByText,
-        getByRole = _render9.getByRole;
-
+        text: "my-heading-test",
+        level: 2,
+        as: "h4"
+      })),
+      getByText = _render9.getByText,
+      getByRole = _render9.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 4
@@ -129,13 +116,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 3 and as h2", function () {
     var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 3,
-      as: "h2"
-    })),
-        getByText = _render10.getByText,
-        getByRole = _render10.getByRole;
-
+        text: "my-heading-test",
+        level: 3,
+        as: "h2"
+      })),
+      getByText = _render10.getByText,
+      getByRole = _render10.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 2
@@ -143,13 +129,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 4 and as h3", function () {
     var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 4,
-      as: "h3"
-    })),
-        getByText = _render11.getByText,
-        getByRole = _render11.getByRole;
-
+        text: "my-heading-test",
+        level: 4,
+        as: "h3"
+      })),
+      getByText = _render11.getByText,
+      getByRole = _render11.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 3
@@ -157,13 +142,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 5 as h4", function () {
     var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 5,
-      as: "h4"
-    })),
-        getByText = _render12.getByText,
-        getByRole = _render12.getByRole;
-
+        text: "my-heading-test",
+        level: 5,
+        as: "h4"
+      })),
+      getByText = _render12.getByText,
+      getByRole = _render12.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 4
@@ -171,13 +155,12 @@ describe("Heading component tests", function () {
   });
   test("Heading renders with level 5 and invalid as", function () {
     var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
-      text: "my-heading-test",
-      level: 5,
-      as: "h4afdssf"
-    })),
-        getByText = _render13.getByText,
-        getByRole = _render13.getByRole;
-
+        text: "my-heading-test",
+        level: 5,
+        as: "h4afdssf"
+      })),
+      getByText = _render13.getByText,
+      getByRole = _render13.getByRole;
     expect(getByText("my-heading-test")).toBeTruthy();
     expect(getByRole("heading", {
       level: 5

package/heading/types.d.ts

@@ -1,11 +1,11 @@
-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 Props = {
+type Props = {
     /**
      * Defines the heading level from 1 to 5. The styles of the heading are applied according to the level.
      * The html tag of the heading will be the one specified in the 'as' prop.
@@ -16,14 +16,14 @@ declare type Props = {
      * Heading text.
      */
     text: string;
-    /**
-     * Specifies the html tag of the heading.
-     */
-    as?: "h1" | "h2" | "h3" | "h4" | "h5";
     /**
      * Modifies the default weight of the heading.
      */
     weight?: "light" | "normal" | "bold";
+    /**
+     * Specifies the HTML tag of the heading.
+     */
+    as?: "h1" | "h2" | "h3" | "h4" | "h5";
     /**
      * 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.

package/icon/Icon.accessibility.test.js

@@ -0,0 +1,30 @@
+"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 _Icon = _interopRequireDefault(require("./Icon"));
+describe("Icon 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(_Icon["default"], {
+            icon: "home"
+          })), container = _render.container;
+          _context.next = 3;
+          return (0, _axeHelper.axe)(container);
+        case 3:
+          results = _context.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+});

package/icon/Icon.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import IconPropsType from "./types";
+declare const DxcIcon: ({ icon }: IconPropsType) => JSX.Element;
+export default DxcIcon;

package/icon/Icon.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _react = _interopRequireDefault(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _templateObject;
+var DxcIcon = function DxcIcon(_ref) {
+  var icon = _ref.icon;
+  var filled = false;
+  var iconName = icon;
+  if (icon.startsWith("filled_")) {
+    filled = true;
+    iconName = icon.replace(/filled_/g, "");
+  }
+  return /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    role: "img",
+    "aria-label": icon,
+    filled: filled,
+    icon: iconName,
+    "aria-hidden": "true"
+  });
+};
+var IconContainer = _styledComponents["default"].span(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: \"Material Symbols Outlined\";\n  font-weight: normal;\n  font-style: normal;\n  line-height: 1;\n  letter-spacing: normal;\n  text-transform: none;\n  display: inline-block;\n  white-space: nowrap;\n  word-wrap: normal;\n  direction: ltr;\n  -webkit-font-feature-settings: \"liga\";\n  -webkit-font-smoothing: antialiased;\n  text-rendering: optimizeLegibility;\n  -moz-osx-font-smoothing: grayscale;\n  font-variation-settings: ", ";\n  ::before {\n    content: \"", "\";\n  }\n"])), function (props) {
+  return props.filled ? "'FILL' 1" : "'FILL' 0";
+}, function (props) {
+  return props.icon;
+});
+var _default = exports["default"] = DxcIcon;

package/icon/Icon.stories.tsx

@@ -0,0 +1,28 @@
+import React from "react";
+import DxcIcon from "./Icon";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { DxcTypography } from "../main";
+
+export default {
+  title: "Icon",
+  component: DxcIcon,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Icon component" theme="light" level={2} />
+    <ExampleContainer>
+      <DxcTypography as="p" fontSize="1.5rem">
+        <DxcIcon icon="home" />
+        <DxcIcon icon="filled_home" />
+      </DxcTypography>
+    </ExampleContainer>
+    <ExampleContainer>
+      <DxcTypography as="p" fontSize="1.5rem" color="#b182e3">
+        <DxcIcon icon="home" />
+        <DxcIcon icon="filled_home" />
+      </DxcTypography>
+    </ExampleContainer>
+  </>
+);

package/icon/types.d.ts

@@ -0,0 +1,4 @@
+type Props = {
+    icon: string;
+};
+export default Props;

package/icon/types.js

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

package/image/Image.accessibility.test.js

@@ -0,0 +1,56 @@
+"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 _Image = _interopRequireDefault(require("./Image"));
+describe("Image 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(_Image["default"], {
+            alt: "Example image",
+            width: "100%",
+            src: "https://images.ctfassets.net/hrltx12pl8hq/5596z2BCR9KmT1KeRBrOQa/4070fd4e2f1a13f71c2c46afeb18e41c/shutterstock_451077043-hero1.jpg",
+            caption: "Caption"
+          })), container = _render.container;
+          _context.next = 3;
+          return (0, _axeHelper.axe)(container);
+        case 3:
+          results = _context.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  it("Should not have basic accessibility issues for lazy-loading mode", /*#__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(_Image["default"], {
+            alt: "Example image",
+            width: "100%",
+            src: "https://images.ctfassets.net/hrltx12pl8hq/5596z2BCR9KmT1KeRBrOQa/4070fd4e2f1a13f71c2c46afeb18e41c/shutterstock_451077043-hero1.jpg",
+            caption: "Caption",
+            lazyLoading: true
+          })), container = _render2.container;
+          _context2.next = 3;
+          return (0, _axeHelper.axe)(container);
+        case 3:
+          results = _context2.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+});

package/image/Image.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import ImagePropsType from "./types";
+declare const DxcImage: ({ alt, caption, lazyLoading, src, srcSet, sizes, width, height, objectFit, objectPosition, onLoad, onError, }: ImagePropsType) => React.JSX.Element;
+export default DxcImage;

package/image/Image.js

@@ -0,0 +1,70 @@
+"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 = _interopRequireDefault(require("react"));
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+var _BaseTypography = _interopRequireDefault(require("../utils/BaseTypography"));
+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 CaptionWrapper = function CaptionWrapper(_ref) {
+  var condition = _ref.condition,
+    wrapper = _ref.wrapper,
+    children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, condition ? wrapper(children) : children);
+};
+var DxcImage = function DxcImage(_ref2) {
+  var alt = _ref2.alt,
+    caption = _ref2.caption,
+    _ref2$lazyLoading = _ref2.lazyLoading,
+    lazyLoading = _ref2$lazyLoading === void 0 ? false : _ref2$lazyLoading,
+    src = _ref2.src,
+    srcSet = _ref2.srcSet,
+    sizes = _ref2.sizes,
+    width = _ref2.width,
+    height = _ref2.height,
+    objectFit = _ref2.objectFit,
+    objectPosition = _ref2.objectPosition,
+    onLoad = _ref2.onLoad,
+    onError = _ref2.onError;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.image
+  }, /*#__PURE__*/_react["default"].createElement(CaptionWrapper, {
+    condition: caption != undefined,
+    wrapper: function wrapper(children) {
+      return /*#__PURE__*/_react["default"].createElement(Figure, null, children, /*#__PURE__*/_react["default"].createElement(_BaseTypography["default"], {
+        as: "figcaption",
+        color: colorsTheme.image.captionFontColor,
+        fontFamily: colorsTheme.image.captionFontFamily,
+        fontSize: colorsTheme.image.captionFontSize,
+        fontStyle: colorsTheme.image.captionFontStyle,
+        fontWeight: colorsTheme.image.captionFontWeight,
+        lineHeight: colorsTheme.image.captionLineHeight
+      }, caption));
+    }
+  }, /*#__PURE__*/_react["default"].createElement("img", {
+    alt: alt,
+    loading: lazyLoading ? "lazy" : undefined,
+    onLoad: onLoad,
+    onError: onError,
+    src: src,
+    srcSet: srcSet,
+    sizes: sizes,
+    style: {
+      objectFit: objectFit,
+      objectPosition: objectPosition,
+      width: width,
+      height: height
+    }
+  })));
+};
+var Figure = _styledComponents["default"].figure(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n  gap: 1rem;\n  width: fit-content;\n  margin: 0;\n  padding: 0;\n"])));
+var _default = exports["default"] = DxcImage;