@dxc-technology/halstack-react 0.0.0-c593452 → 0.0.0-c5cf7cd

package/button/types.d.ts

@@ -1,19 +1,19 @@
-declare type Size = "small" | "medium" | "large" | "fillParent" | "fitContent";
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+/// <reference types="react" />
+export declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+export declare type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type SVG = string | (HTMLElement & SVGElement);
+export declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
 declare type Props = {
     /**
-     * Text to be placed next to the button.
+     * Text to be placed in the button.
      */
     label?: string;
     /**
-     * Uses one of the available button modes.
+     * The available button modes.
      */
     mode?: "primary" | "secondary" | "text";
     /**
@@ -25,32 +25,28 @@ declare type Props = {
      */
     iconPosition?: "before" | "after";
     /**
-     * This prop corresponds to the 'type' prop of the button in html.
+     * 'type' html prop of the button.
      */
     type?: "button" | "reset" | "submit";
     /**
-     * DEPRECATED. URL of the icon that will be placed next to the button label.
+     * Element or path used as the icon that will be placed next to the label.
      */
-    iconSrc?: string;
+    icon?: string | SVG;
     /**
-     * Element used as the icon that will be placed next to the button label.
+     * This function will be called when the user clicks the button.
      */
-    icon?: SVG;
-    /**
-     * This function will be called when the user clicks the button. The event object will be passed as a parameter.
-     */
-    onClick?: any;
+    onClick?: () => void;
     /**
      * 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.
      */
     margin?: Space | Margin;
     /**
-     * Size of the component ('small' | 'medium' | 'large' | 'fillParent' | 'fitContent').
+     * Size of the component.
      */
-    size?: Size;
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
     /**
-     * Value of the tabindex.
+     * Value of the tabindex attribute.
      */
     tabIndex?: number;
 };

package/card/Card.js

@@ -21,11 +21,11 @@ var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
 var _variables = require("../common/variables.js");
 
-var _useTheme = _interopRequireDefault(require("../useTheme.js"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
 
 var _Box = _interopRequireDefault(require("../box/Box"));
 
-var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
@@ -47,7 +47,7 @@ var DxcCard = function DxcCard(_ref) {
       _ref$tabIndex = _ref.tabIndex,
       tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex,
       _ref$outlined = _ref.outlined,
-      outlined = _ref$outlined === void 0 ? false : _ref$outlined,
+      outlined = _ref$outlined === void 0 ? true : _ref$outlined,
       children = _ref.children;
   var colorsTheme = (0, _useTheme["default"])();
 
@@ -56,23 +56,13 @@ var DxcCard = function DxcCard(_ref) {
       isHovered = _useState2[0],
       changeIsHovered = _useState2[1];
 
-  var tagContent = /*#__PURE__*/_react["default"].createElement(_Box["default"], {
-    shadowDepth: outlined ? 0 : isHovered && (onClick || linkHref) ? 2 : 1
-  }, /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
-    theme: colorsTheme.card
-  }, /*#__PURE__*/_react["default"].createElement(CardContainer, {
-    hasAction: onClick || linkHref,
-    outlined: outlined,
-    imagePosition: imagePosition
-  }, imageSrc && /*#__PURE__*/_react["default"].createElement(ImageContainer, {
+  var imageComponent = /*#__PURE__*/_react["default"].createElement(ImageContainer, {
     imageBgColor: imageBgColor
   }, /*#__PURE__*/_react["default"].createElement(TagImage, {
     imagePadding: imagePadding,
     cover: imageCover,
     src: imageSrc
-  })), /*#__PURE__*/_react["default"].createElement(CardContent, {
-    contentPadding: contentPadding
-  }, children))));
+  }));
 
   return /*#__PURE__*/_react["default"].createElement(StyledDxcCard, {
     margin: margin,
@@ -83,15 +73,23 @@ var DxcCard = function DxcCard(_ref) {
       return changeIsHovered(false);
     },
     onClick: onClick,
-    hasAction: onClick,
-    tabIndex: typeof onClick === "function" && !linkHref ? tabIndex : -1
-  }, linkHref && /*#__PURE__*/_react["default"].createElement(StyledLink, {
-    tabIndex: tabIndex,
+    hasAction: onClick || linkHref,
+    tabIndex: onClick || linkHref ? tabIndex : -1,
+    as: linkHref && "a",
     href: linkHref
-  }, tagContent) || tagContent);
+  }, /*#__PURE__*/_react["default"].createElement(_Box["default"], {
+    shadowDepth: !outlined ? 0 : isHovered && (onClick || linkHref) ? 2 : 1
+  }, /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.card
+  }, /*#__PURE__*/_react["default"].createElement(CardContainer, {
+    hasAction: onClick || linkHref,
+    imagePosition: imagePosition
+  }, imageSrc && imagePosition === "before" && imageComponent, /*#__PURE__*/_react["default"].createElement(CardContent, {
+    contentPadding: contentPadding
+  }, children), imageSrc && imagePosition === "after" && imageComponent))));
 };
 
-var StyledDxcCard = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  cursor: ", ";\n  outline: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n"])), function (_ref2) {
+var StyledDxcCard = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  cursor: ", ";\n  outline: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  text-decoration: none;\n\n  ", "\n"])), function (_ref2) {
   var hasAction = _ref2.hasAction;
   return hasAction && "pointer" || "unset";
 }, function (_ref3) {
@@ -112,12 +110,12 @@ var StyledDxcCard = _styledComponents["default"].div(_templateObject || (_templa
 }, function (_ref8) {
   var margin = _ref8.margin;
   return margin && margin.left ? _variables.spaces[margin.left] : "";
+}, function (_ref9) {
+  var hasAction = _ref9.hasAction;
+  return hasAction && ":focus {\n    outline: #0095ff auto 1px;\n  }";
 });
 
-var CardContainer = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  flex-direction: ", ";\n  height: ", ";\n  width: ", ";\n  &:hover {\n    border-color: ", ";\n  }\n"])), function (_ref9) {
-  var imagePosition = _ref9.imagePosition;
-  return imagePosition === "before" && "row" || "row-reverse";
-}, function (props) {
+var CardContainer = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  height: ", ";\n  width: ", ";\n  &:hover {\n    border-color: ", ";\n  }\n"])), function (props) {
   return props.theme.height;
 }, function (props) {
   return props.theme.width;
@@ -126,9 +124,7 @@ var CardContainer = _styledComponents["default"].div(_templateObject2 || (_templ
   return hasAction ? "" : "unset";
 });
 
-var StyledLink = _styledComponents["default"].a(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  cursor: pointer;\n  text-decoration: none;\n"])));
-
-var TagImage = _styledComponents["default"].img(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: ", ";\n  width: ", ";\n  object-fit: ", ";\n"])), function (_ref11) {
+var TagImage = _styledComponents["default"].img(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  height: ", ";\n  width: ", ";\n  object-fit: ", ";\n"])), function (_ref11) {
   var imagePadding = _ref11.imagePadding;
   return !imagePadding ? "100%" : "calc(100% - ".concat(_variables.spaces[imagePadding], " - ").concat(_variables.spaces[imagePadding], ")");
 }, function (_ref12) {
@@ -139,12 +135,12 @@ var TagImage = _styledComponents["default"].img(_templateObject4 || (_templateOb
   return cover ? "cover" : "contain";
 });
 
-var ImageContainer = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  width: 35%;\n  height: 100%;\n  flex-shrink: 0;\n  background: ", ";\n  justify-content: center;\n  align-items: center;\n  display: inline-flex;\n"])), function (_ref14) {
+var ImageContainer = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  width: 35%;\n  height: 100%;\n  flex-shrink: 0;\n  background: ", ";\n  justify-content: center;\n  align-items: center;\n  display: inline-flex;\n"])), function (_ref14) {
   var imageBgColor = _ref14.imageBgColor;
   return imageBgColor;
 });
 
-var CardContent = _styledComponents["default"].div(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  flex-grow: 1;\n  padding: ", ";\n  padding-top: ", ";\n  padding-right: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  overflow: hidden;\n"])), function (_ref15) {
+var CardContent = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  flex-grow: 1;\n  padding: ", ";\n  padding-top: ", ";\n  padding-right: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  overflow: hidden;\n"])), function (_ref15) {
   var contentPadding = _ref15.contentPadding;
   return contentPadding && (0, _typeof2["default"])(contentPadding) !== "object" ? _variables.spaces[contentPadding] : "0px";
 }, function (_ref16) {

package/card/Card.stories.tsx

@@ -0,0 +1,201 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcCard from "./Card";
+import imagePath from "./ice-cream.jpg";
+import { userEvent, within } from "@storybook/testing-library";
+
+export default {
+  title: "Card",
+  component: DxcCard,
+};
+
+const Card = () => (
+  <>
+    <Title title="Default" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard>Default</DxcCard>
+    </ExampleContainer>
+    <Title title="Not outlined" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard outlined={false}>Not outlined</DxcCard>
+    </ExampleContainer>
+    <Title title="Default with link" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard linkHref="https://www.dxc.com">Default with link</DxcCard>
+    </ExampleContainer>
+    <Title title="Focused default with link" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard linkHref="https://www.dxc.com">Focused default with link</DxcCard>
+    </ExampleContainer>
+    <Title title="Hovered default with link" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard linkHref="https://www.dxc.com">Hovered default with link</DxcCard>
+    </ExampleContainer>
+    <Title title="Default with action" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard onClick={() => {}}>Default with action</DxcCard>
+    </ExampleContainer>
+    <Title title="Default with image" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc={imagePath}>Default</DxcCard>
+    </ExampleContainer>
+    <Title title="Default image with background color" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc={imagePath} imageBgColor="yellow">
+        Background color
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Default image with position after" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc={imagePath} imagePosition="after">
+        Position after
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Image cover" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc={imagePath} imageCover>
+        Image cover
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Image cover with position after" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc={imagePath} imageCover imagePosition="after">
+        Image cover with position after
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Image padding" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="xxsmall" imageCover>
+        Xxsmall
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="xsmall" imageCover>
+        Xsmall
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="small" imageCover>
+        Small
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="medium" imageCover>
+        Medium
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="large" imageCover>
+        Large
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="xlarge" imageCover>
+        Xlarge
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcCard imageSrc={imagePath} imagePadding="xxlarge" imageCover>
+        Xxlarge
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Content padding" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcCard contentPadding="xxsmall">Xxsmall</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcCard contentPadding="xsmall">Xsmall</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcCard contentPadding="small">Small</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcCard contentPadding="medium">Medium</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcCard contentPadding="large">Large</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcCard contentPadding="xlarge">Xlarge</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcCard contentPadding="xxlarge">Xxlarge</DxcCard>
+    </ExampleContainer>
+    <Title title="Margin" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcCard margin="xxsmall">Xxsmall</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcCard margin="xsmall">Xsmall</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcCard margin="small">Small</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcCard margin="medium">Medium</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcCard margin="large">Large</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcCard margin="xlarge">Xlarge</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcCard margin="xxlarge">Xxlarge</DxcCard>
+    </ExampleContainer>
+  </>
+);
+
+const actionCard = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Focused default with action" theme="light" level={4} />
+      <DxcCard onClick={() => {}}>Focused default with action</DxcCard>
+    </ExampleContainer>
+    <ExampleContainer expanded>
+      <Title title="Hovered default with action" theme="light" level={4} />
+      <DxcCard onClick={() => {}}>Hovered default with action</DxcCard>
+    </ExampleContainer>
+  </>
+);
+
+const linkStates = async (focusCard, hoverCard) => {
+  await focusCard.focus();
+  await userEvent.hover(hoverCard);
+};
+
+export const ActionCardStates = actionCard.bind({});
+ActionCardStates.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  await userEvent.tab();
+  await userEvent.hover(canvas.getAllByText("Hovered default with action")[1]);
+};
+
+export const Chromatic = Card.bind({});
+Chromatic.play = async ({ canvasElement }) => {
+  const canvas = within(canvasElement);
+  const linkCards = canvas.getAllByRole("link");
+  await linkStates(linkCards[1], linkCards[2]);
+};

package/card/Card.test.js

@@ -0,0 +1,50 @@
+"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"));
+
+describe("Card component tests", function () {
+  test("Card renders with correct content", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], null, "test-card")),
+        getByText = _render.getByText;
+
+    expect(getByText("test-card")).toBeTruthy();
+  });
+  test("Card renders with correct href", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
+      linkHref: "/testPage"
+    }, "test-card")),
+        getByRole = _render2.getByRole;
+
+    var card = getByRole("link");
+    expect(card.getAttribute("href")).toEqual("/testPage");
+  });
+  test("Card renders with correct image", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
+      imageSrc: "/testImage"
+    }, "test-card")),
+        getByRole = _render3.getByRole;
+
+    var card = getByRole("img");
+    expect(card.getAttribute("src")).toEqual("/testImage");
+  });
+  test("OnClick function is called", function () {
+    var onClick = jest.fn();
+
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
+      onClick: onClick
+    }, "test-card")),
+        getByText = _render4.getByText;
+
+    var card = getByText("test-card");
+
+    _react2.fireEvent.click(card);
+
+    expect(onClick).toHaveBeenCalled();
+  });
+});

package/card/types.d.ts

@@ -42,15 +42,14 @@ declare type Props = {
      */
     imageCover?: boolean;
     /**
-     * Size of the margin to be applied to the component. You can pass
-     * an object with 'top', 'bottom', 'left' and 'right' properties
-     * in order to specify different margin sizes.
+     * 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.
      */
     margin?: Space | Size;
     /**
-     * Size of the padding to be applied to the content area. You can pass
-     * an object with 'top', 'bottom', 'left' and 'right' properties in
-     * order to specify different padding sizes.
+     * @deprecated This prop will be removed shortly, consider using the Inset component for this purpose.
+     * Size of the padding to be applied to the content 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.
      */
     contentPadding?: Space | Size;
     /**

package/checkbox/Checkbox.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import React from "react";
 import CheckboxPropsType from "./types";
-declare const DxcCheckbox: ({ checked, value, label, labelPosition, name, disabled, onChange, required, margin, size, tabIndex, }: CheckboxPropsType) => JSX.Element;
+declare const DxcCheckbox: React.ForwardRefExoticComponent<CheckboxPropsType & React.RefAttributes<HTMLDivElement>>;
 export default DxcCheckbox;