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

package/image/Image.accessibility.test.d.ts

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

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;

package/image/Image.stories.tsx

@@ -0,0 +1,129 @@
+import React from "react";
+import DxcImage from "./Image";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcFlex from "../flex/Flex";
+import DxcInset from "../inset/Inset";
+import DxcParagraph from "../paragraph/Paragraph";
+
+export default {
+  title: "Image",
+  component: DxcImage,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Image component" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Simple image" theme="light" level={4} />
+      <DxcImage
+        alt="Example image"
+        width="100%"
+        src="https://images.ctfassets.net/hrltx12pl8hq/5596z2BCR9KmT1KeRBrOQa/4070fd4e2f1a13f71c2c46afeb18e41c/shutterstock_451077043-hero1.jpg"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Image with text" theme="light" level={4} />
+      <DxcParagraph>
+        Lorem ipsum dolor sit amet consectetur. Tincidunt sed pharetra mollis duis volutpat urna. Hendrerit aliquet et
+        arcu purus. Sodales elementum sollicitudin consequat elementum tortor. Lectus eget cursus ut ac pharetra
+        lobortis integer eu. Potenti amet ac id risus ac nunc orci nibh. Tempus vitae vitae aenean arcu. Nibh tristique
+        porta dui enim eget tristique rutrum. Quisque faucibus suscipit nibh est sed. Netus venenatis congue diam in dui
+        morbi dignissim lorem. Urna aliquet sem in tincidunt. Nunc arcu nec fringilla enim purus ut justo nisi. Vel mus
+        ut ornare faucibus blandit diam sit vestibulum massa. Semper nullam sit sagittis hendrerit augue. In fermentum
+        metus proin arcu faucibus proin nibh sit. Vel integer sed enim in sed vel nec ut vitae. Commodo sagittis
+        volutpat id lorem.
+      </DxcParagraph>
+      <DxcInset top="2rem" bottom="2rem">
+        <DxcImage
+          alt="Ratatouille is a great movie"
+          caption="Ratatouille with a smile on his face."
+          src="https://hips.hearstapps.com/es.h-cdn.co/fotoes/images/cinefilia/por-que-ratatouille-nos-sigue-enamorando-10-anos-despues/136444706-1-esl-ES/Por-que-Ratatouille-nos-sigue-enamorando-10-anos-despues.jpg"
+        />
+      </DxcInset>
+      <DxcParagraph>
+        Lorem ipsum dolor sit amet consectetur. Tincidunt sed pharetra mollis duis volutpat urna. Hendrerit aliquet et
+        arcu purus. Sodales elementum sollicitudin consequat elementum tortor. Lectus eget cursus ut ac pharetra
+        lobortis integer eu. Potenti amet ac id risus ac nunc orci nibh. Tempus vitae vitae aenean arcu. Nibh tristique
+        porta dui enim eget tristique rutrum. Quisque faucibus suscipit nibh est sed. Netus venenatis congue diam in dui
+        morbi dignissim lorem. Urna aliquet sem in tincidunt. Nunc arcu nec fringilla enim purus ut justo nisi. Vel mus
+        ut ornare faucibus blandit diam sit vestibulum massa. Semper nullam sit sagittis hendrerit augue. In fermentum
+        metus proin arcu faucibus proin nibh sit. Vel integer sed enim in sed vel nec ut vitae. Commodo sagittis
+        volutpat id lorem.
+      </DxcParagraph>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Example image" theme="light" level={4} />
+      <DxcFlex gap="1rem">
+        <DxcImage
+          alt="Camera pic"
+          caption="Picture of a camera and the sunset."
+          width="500px"
+          src="https://assets.entrepreneur.com/content/3x2/2000/20191009140007-GettyImages-1053962188.jpeg"
+        />
+        <DxcParagraph>
+          Lorem ipsum dolor sit amet consectetur. Tincidunt sed pharetra mollis duis volutpat urna. Hendrerit aliquet et
+          arcu purus. Sodales elementum sollicitudin consequat elementum tortor. Lectus eget cursus ut ac pharetra
+          lobortis integer eu. Potenti amet ac id risus ac nunc orci nibh. Tempus vitae vitae aenean arcu. Nibh
+          tristique porta dui enim eget tristique rutrum. Quisque faucibus suscipit nibh est sed. Netus venenatis congue
+          diam in dui morbi dignissim lorem. Urna aliquet sem in tincidunt. Nunc arcu nec fringilla enim purus ut justo
+          nisi. Vel mus ut ornare faucibus blandit diam sit vestibulum massa. Semper nullam sit sagittis hendrerit
+          augue. In fermentum metus proin arcu faucibus proin nibh sit. Vel integer sed enim in sed vel nec ut vitae.
+          Commodo sagittis volutpat id lorem. Lorem ipsum dolor sit amet consectetur. Tincidunt sed pharetra mollis duis
+          volutpat urna. Hendrerit aliquet et arcu purus. Sodales elementum sollicitudin consequat elementum tortor.
+          Lectus eget cursus ut ac pharetra lobortis integer eu. Potenti amet ac id risus ac nunc orci nibh. Tempus
+          vitae vitae aenean arcu. Nibh tristique porta dui enim eget tristique rutrum. Quisque faucibus suscipit nibh
+          est sed. Netus venenatis congue diam in dui morbi dignissim lorem. Urna aliquet sem in tincidunt. Nunc arcu
+          nec fringilla enim purus ut justo nisi. Vel mus ut ornare faucibus blandit diam sit vestibulum massa. Semper
+          nullam sit sagittis hendrerit augue. In fermentum metus proin arcu faucibus proin nibh sit. Vel integer sed
+          enim in sed vel nec ut vitae. Commodo sagittis volutpat id lorem.
+        </DxcParagraph>
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Object position" theme="light" level={4} />
+      <DxcImage
+        alt="Moon pic"
+        caption="Picture of the moon."
+        width="250px"
+        src="https://interactive-examples.mdn.mozilla.net/media/examples/moon.jpg"
+        objectPosition="right top"
+        objectFit="none"
+      />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Object fit: contain" theme="light" level={4} />
+      <div style={{ display: "flex", width: "fit-content", border: "1px solid #000", padding: "0.5rem" }}>
+        <DxcImage
+          alt="Dog pic"
+          src="https://cc-prod.scene7.com/is/image/CCProdAuthor/What-is-Stock-Photography_P1_mobile?$pjpeg$&jpegSize=200&wid=720"
+          width="200px"
+          height="200px"
+          objectFit="contain"
+          caption="Pretty dog."
+        />
+      </div>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Object fit: cover" theme="light" level={4} />
+      <div style={{ width: "75%", height: "300px" }}>
+        <DxcImage
+          alt="Spaceship pic"
+          src="https://media.istockphoto.com/id/1344443930/es/foto/lanzamiento-de-cohetes-del-transbordador-espacial-en-el-cielo-y-nubes-al-espacio-exterior.jpg?s=612x612&w=0&k=20&c=CO2A96GnnWvJsgZuj9WfYCVIBVzicnQDfnzwD1nomN0="
+          objectFit="cover"
+          width="50%"
+          height="100%"
+          objectPosition="0px 0px"
+        />
+        <DxcImage
+          alt="Spaceship pic"
+          src="https://media.istockphoto.com/id/1344443930/es/foto/lanzamiento-de-cohetes-del-transbordador-espacial-en-el-cielo-y-nubes-al-espacio-exterior.jpg?s=612x612&w=0&k=20&c=CO2A96GnnWvJsgZuj9WfYCVIBVzicnQDfnzwD1nomN0="
+          objectFit="cover"
+          width="50%"
+          height="100%"
+          objectPosition="0px 0px"
+        />
+      </div>
+    </ExampleContainer>
+  </>
+);

package/image/types.d.ts

@@ -0,0 +1,72 @@
+/// <reference types="react" />
+type Props = {
+    /**
+     * Alternative text description displayed when the specified image is not loaded.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt
+     * See W3C alt decision tree: https://www.w3.org/WAI/tutorials/images/decision-tree/
+     */
+    alt: string;
+    /**
+     * Image legend with a descriptive purpose. It is placed below the image and is complementary to the alt attribute,
+     * which is required regardless of the presence of the caption or not.
+     */
+    caption?: string;
+    /**
+     * If true, the image will be loaded only when it is visible on the screen (lazy loading).
+     * Otherwise and by default, the image will be loaded as soon as the component is mounted (eager loading).
+     */
+    lazyLoading?: boolean;
+    /**
+     * URL of the image. This prop is required and must be valid.
+     */
+    src: string;
+    /**
+     * List of one or more strings separated by commas indicating a set of possible images for the user agent to use.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset
+     */
+    srcSet?: string;
+    /**
+     * One or more strings separated by commas, indicating a set of source sizes.
+     * If the srcSet attribute is absent or contains no values with a width descriptor,
+     * then this attribute has no effect.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes
+     */
+    sizes?: string;
+    /**
+     * Sets the rendered width of the image.
+     */
+    width?: string;
+    /**
+     * Sets the rendered height of the image.
+     */
+    height?: string;
+    /**
+     * Sets the object-fit CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
+     */
+    objectFit?: "contain" | "cover" | "fill" | "none" | "scale-down";
+    /**
+     * Sets the object-position CSS property.
+     *
+     * See MDN: https://developer.mozilla.org/en-US/docs/Web/CSS/object-position
+     */
+    objectPosition?: string;
+    /**
+     * This function will be called when the image is loaded.
+     */
+    onLoad?: React.ReactEventHandler<HTMLImageElement>;
+    /**
+     * This function will be called when the image fails to load.
+     */
+    onError?: React.ReactEventHandler<HTMLImageElement>;
+};
+export type CaptionWrapperProps = {
+    condition: boolean;
+    wrapper: (children: React.ReactNode) => JSX.Element;
+    children: React.ReactNode;
+};
+export default Props;

package/image/types.js

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

package/inset/Inset.js

@@ -1,29 +1,23 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = Inset;
-
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-
 var _react = _interopRequireDefault(require("react"));
-
 var _styledComponents = _interopRequireDefault(require("styled-components"));
-
 var _templateObject;
-
 function Inset(_ref) {
   var space = _ref.space,
-      horizontal = _ref.horizontal,
-      vertical = _ref.vertical,
-      top = _ref.top,
-      right = _ref.right,
-      bottom = _ref.bottom,
-      left = _ref.left,
-      children = _ref.children;
+    horizontal = _ref.horizontal,
+    vertical = _ref.vertical,
+    top = _ref.top,
+    right = _ref.right,
+    bottom = _ref.bottom,
+    left = _ref.left,
+    children = _ref.children;
   return /*#__PURE__*/_react["default"].createElement(StyledInset, {
     space: space,
     horizontal: horizontal,
@@ -34,18 +28,16 @@ function Inset(_ref) {
     left: left
   }, children);
 }
-
 function getSpacingValue(spacingName) {
   return spacingName ? spacingName : "0rem";
 }
-
 var StyledInset = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  ", "\n"])), function (_ref2) {
   var space = _ref2.space,
-      horizontal = _ref2.horizontal,
-      vertical = _ref2.vertical,
-      top = _ref2.top,
-      right = _ref2.right,
-      bottom = _ref2.bottom,
-      left = _ref2.left;
+    horizontal = _ref2.horizontal,
+    vertical = _ref2.vertical,
+    top = _ref2.top,
+    right = _ref2.right,
+    bottom = _ref2.bottom,
+    left = _ref2.left;
   return "\n  padding: ".concat(getSpacingValue(top || vertical || space), " ").concat(getSpacingValue(right || horizontal || space), "\n    ").concat(getSpacingValue(bottom || vertical || space), " ").concat(getSpacingValue(left || horizontal || space), ";\n");
 });

package/inset/Inset.stories.tsx

@@ -205,7 +205,7 @@ export const Chromatic = () => (
     </Container>
     <Title title="Inside a flex column" level={4} />
     <Container>
-      <DxcFlex direction="column" gap="0.75rem">
+      <DxcFlex direction="column" gap="1rem">
         <Placeholder></Placeholder>
         <DxcInset top="0.25rem" right="1.5rem" bottom="2rem" left="4rem">
           <Placeholder></Placeholder>
@@ -225,5 +225,6 @@ const Placeholder = styled.div`
   min-height: 40px;
   min-width: 120px;
   border: 1px solid #a46ede;
+  border-radius: 0.5rem;
   background-color: #e5d5f6;
 `;

package/inset/types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
-declare type Spacing = "0rem" | "0.125rem" | "0.25rem" | "0.5rem" | "1rem" | "1.5rem" | "2rem" | "3rem" | "4rem" | "5rem";
-declare type Props = {
+type Spacing = "0rem" | "0.125rem" | "0.25rem" | "0.5rem" | "1rem" | "1.5rem" | "2rem" | "3rem" | "4rem" | "5rem";
+type Props = {
     /**
      * Applies the spacing scale to all sides.
      */

package/layout/ApplicationLayout.d.ts

@@ -3,15 +3,15 @@ import AppLayoutPropsType, { AppLayoutMainPropsType } from "./types";
 declare const DxcApplicationLayout: {
     ({ visibilityToggleLabel, header, sidenav, footer, children, }: AppLayoutPropsType): JSX.Element;
     Header: {
-        ({ underlined, content, responsiveContent, onClick, margin, padding, tabIndex, }: import("../header/types").default): JSX.Element;
-        Dropdown: (props: any) => JSX.Element;
+        ({ underlined, content, responsiveContent, onClick, margin, tabIndex, }: import("../header/types").default): JSX.Element;
+        Dropdown: (props: import("../dropdown/types").default) => React.JSX.Element;
     };
     Main: ({ children }: AppLayoutMainPropsType) => JSX.Element;
-    Footer: ({ socialLinks, bottomLinks, copyright, children, padding, margin, tabIndex, }: import("../footer/types").default) => JSX.Element;
+    Footer: ({ socialLinks, bottomLinks, copyright, children, margin, tabIndex, mode, }: import("../footer/types").default) => JSX.Element;
     SideNav: {
-        ({ children, title }: import("../sidenav/types").default): JSX.Element;
+        ({ title, children }: import("../sidenav/types").default): JSX.Element;
         Section: ({ children }: import("../sidenav/types").SidenavSectionPropsType) => JSX.Element;
-        Group: ({ children, title, collapsable, icon }: import("../sidenav/types").SidenavGroupPropsType) => JSX.Element;
+        Group: ({ title, collapsable, icon, children }: import("../sidenav/types").SidenavGroupPropsType) => JSX.Element;
         Link: React.ForwardRefExoticComponent<import("../sidenav/types").SidenavLinkPropsType & React.RefAttributes<HTMLAnchorElement>>;
         Title: ({ children }: import("../sidenav/types").SidenavTitlePropsType) => JSX.Element;
     };