@dxc-technology/halstack-react 0.0.0-b7324ab → 0.0.0-b7a7d72

package/button/types.d.ts

@@ -0,0 +1,57 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+declare type Props = {
+    /**
+     * Text to be placed in the button.
+     */
+    label?: string;
+    /**
+     * The available button modes.
+     */
+    mode?: "primary" | "secondary" | "text";
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the icon should appear after or before the label.
+     */
+    iconPosition?: "before" | "after";
+    /**
+     * Value for the HTML properties title and aria-label.
+     */
+    title?: string;
+    /**
+     * 'type' html prop of the button.
+     */
+    type?: "button" | "reset" | "submit";
+    /**
+     * Element or path used as the icon that will be placed next to the label.
+     */
+    icon?: string | SVG;
+    /**
+     * This function will be called when the user clicks the button.
+     */
+    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.
+     */
+    size?: "small" | "medium" | "large" | "fillParent" | "fitContent";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/button/types.js

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

package/card/Card.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import CardPropsType from "./types";
+declare const DxcCard: ({ imageSrc, imageBgColor, imagePadding, imagePosition, linkHref, onClick, imageCover, margin, tabIndex, outlined, children, }: CardPropsType) => JSX.Element;
+export default DxcCard;

package/card/Card.js

@@ -0,0 +1,143 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof3 = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _styledComponents = _interopRequireWildcard(require("styled-components"));
+
+var _variables = require("../common/variables");
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _Box = _interopRequireDefault(require("../box/Box"));
+
+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); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof3(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var DxcCard = function DxcCard(_ref) {
+  var imageSrc = _ref.imageSrc,
+      _ref$imageBgColor = _ref.imageBgColor,
+      imageBgColor = _ref$imageBgColor === void 0 ? "black" : _ref$imageBgColor,
+      imagePadding = _ref.imagePadding,
+      _ref$imagePosition = _ref.imagePosition,
+      imagePosition = _ref$imagePosition === void 0 ? "before" : _ref$imagePosition,
+      linkHref = _ref.linkHref,
+      onClick = _ref.onClick,
+      _ref$imageCover = _ref.imageCover,
+      imageCover = _ref$imageCover === void 0 ? false : _ref$imageCover,
+      margin = _ref.margin,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex,
+      _ref$outlined = _ref.outlined,
+      outlined = _ref$outlined === void 0 ? true : _ref$outlined,
+      children = _ref.children;
+  var colorsTheme = (0, _useTheme["default"])();
+
+  var _useState = (0, _react.useState)(false),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      isHovered = _useState2[0],
+      changeIsHovered = _useState2[1];
+
+  return /*#__PURE__*/_react["default"].createElement(Card, {
+    hasAction: onClick || linkHref ? true : false,
+    margin: margin,
+    onMouseEnter: function onMouseEnter() {
+      return changeIsHovered(true);
+    },
+    onMouseLeave: function onMouseLeave() {
+      return changeIsHovered(false);
+    },
+    onClick: onClick,
+    tabIndex: onClick || linkHref ? tabIndex : -1,
+    as: linkHref && "a",
+    href: linkHref
+  }, /*#__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 ? true : false,
+    imagePosition: imageSrc ? imagePosition : "none"
+  }, imageSrc && /*#__PURE__*/_react["default"].createElement(ImageContainer, {
+    imageBgColor: imageBgColor
+  }, /*#__PURE__*/_react["default"].createElement(TagImage, {
+    imagePadding: imagePadding,
+    imageCover: imageCover,
+    src: imageSrc
+  })), /*#__PURE__*/_react["default"].createElement(CardContent, null, children)))));
+};
+
+var Card = _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"])), function (_ref2) {
+  var hasAction = _ref2.hasAction;
+  return hasAction && "pointer" || "unset";
+}, function (_ref3) {
+  var hasAction = _ref3.hasAction;
+  return !hasAction && "none";
+}, function (_ref4) {
+  var margin = _ref4.margin;
+  return margin && (0, _typeof2["default"])(margin) !== "object" ? _variables.spaces[margin] : "0px";
+}, function (_ref5) {
+  var margin = _ref5.margin;
+  return margin && (0, _typeof2["default"])(margin) === "object" && margin.top ? _variables.spaces[margin.top] : "";
+}, function (_ref6) {
+  var margin = _ref6.margin;
+  return margin && (0, _typeof2["default"])(margin) === "object" && margin.right ? _variables.spaces[margin.right] : "";
+}, function (_ref7) {
+  var margin = _ref7.margin;
+  return margin && (0, _typeof2["default"])(margin) === "object" && margin.bottom ? _variables.spaces[margin.bottom] : "";
+}, function (_ref8) {
+  var margin = _ref8.margin;
+  return margin && (0, _typeof2["default"])(margin) === "object" && 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 (props) {
+  return props.imagePosition === "after" ? "row-reverse" : "row";
+}, function (props) {
+  return props.theme.height;
+}, function (props) {
+  return props.theme.width;
+}, function (_ref10) {
+  var hasAction = _ref10.hasAction;
+  return hasAction ? "" : "unset";
+});
+
+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%" : (0, _typeof2["default"])(imagePadding) !== "object" && "calc(100% - ".concat(_variables.spaces[imagePadding], " - ").concat(_variables.spaces[imagePadding], ")");
+}, function (_ref12) {
+  var imagePadding = _ref12.imagePadding;
+  return !imagePadding ? "100%" : (0, _typeof2["default"])(imagePadding) !== "object" && "calc(100% - ".concat(_variables.spaces[imagePadding], " - ").concat(_variables.spaces[imagePadding], ")");
+}, function (_ref13) {
+  var imageCover = _ref13.imageCover;
+  return imageCover ? "cover" : "contain";
+});
+
+var ImageContainer = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  justify-content: center;\n  align-items: center;\n  flex-shrink: 0;\n  width: 35%;\n  height: 100%;\n  background-color: ", ";\n"])), function (_ref14) {
+  var imageBgColor = _ref14.imageBgColor;
+  return imageBgColor;
+});
+
+var CardContent = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  flex-grow: 1;\n  overflow: hidden;\n"])));
+
+var _default = DxcCard;
+exports["default"] = _default;

package/card/Card.stories.tsx

@@ -0,0 +1,171 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcCard from "./Card";
+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="https://picsum.photos/id/1022/200/300">Default</DxcCard>
+    </ExampleContainer>
+    <Title title="Default image with background color" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imageBgColor="yellow">
+        Background color
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Default image with position after" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePosition="after">
+        Position after
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Image cover" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imageCover>
+        Image cover
+      </DxcCard>
+    </ExampleContainer>
+    <Title title="Image cover with position after" theme="light" level={4} />
+    <ExampleContainer>
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" 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="https://picsum.photos/id/1022/200/300" imagePadding="xxsmall" imageCover>
+        Xxsmall
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="xsmall" imageCover>
+        Xsmall
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="small" imageCover>
+        Small
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="medium" imageCover>
+        Medium
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="large" imageCover>
+        Large
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="xlarge" imageCover>
+        Xlarge
+      </DxcCard>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcCard imageSrc="https://picsum.photos/id/1022/200/300" imagePadding="xxlarge" imageCover>
+        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.tsx"));
+
+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

@@ -0,0 +1,62 @@
+/// <reference types="react" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Size = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * URL of the image that will be placed in the card component.
+     * In case of omission, the image container will not appear and
+     * the content will occupy its space.
+     */
+    imageSrc?: string;
+    /**
+     * Color of the image background.
+     */
+    imageBgColor?: string;
+    /**
+     * Size of the padding to be applied to the image section of the
+     * component. You can pass an object with 'top', 'bottom', 'left'
+     * and 'right' properties in order to specify different padding sizes.
+     */
+    imagePadding?: Space | Size;
+    /**
+     * Whether the image should appear in relation to the content.
+     */
+    imagePosition?: "before" | "after";
+    /**
+     * If defined, the tag will be displayed as an anchor, using this prop
+     * as "href". Component will show some visual feedback on hover.
+     */
+    linkHref?: string;
+    /**
+     * This function will be called when the user clicks the card. Component
+     * will show some visual feedback on hover.
+     */
+    onClick?: () => void;
+    /**
+     * Whether the image must cover the whole image area of the card.
+     */
+    imageCover?: boolean;
+    /**
+     * 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;
+    /**
+     * Value of the tabindex attribute applied when the component is clickable.
+     */
+    tabIndex?: number;
+    /**
+     * Determines whether or not the component should have an outline.
+     */
+    outlined?: boolean;
+    /**
+     * Custom content that will be placed inside the component.
+     */
+    children?: React.ReactNode;
+};
+export default Props;

package/card/types.js

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

package/checkbox/Checkbox.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import CheckboxPropsType from "./types";
+declare const DxcCheckbox: React.ForwardRefExoticComponent<CheckboxPropsType & React.RefAttributes<HTMLDivElement>>;
+export default DxcCheckbox;