@dxc-technology/halstack-react 0.0.0-9253572 → 0.0.0-9282b45

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

@@ -0,0 +1,68 @@
+/// <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;
+    /**
+     * @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;
+    /**
+     * Value of the tabindex given when there is an href.
+     */
+    tabIndex?: number;
+    /**
+     * Whether the card must be outlined.
+     */
+    outlined?: boolean;
+    /**
+     * Custom content that will be placed in the card 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 @@
+/// <reference types="react" />
+import CheckboxPropsType from "./types";
+declare const DxcCheckbox: ({ checked, defaultChecked, value, label, labelPosition, name, disabled, optional, onChange, margin, size, tabIndex, }: CheckboxPropsType) => JSX.Element;
+export default DxcCheckbox;