@dxc-technology/halstack-react 0.0.0-099fc65 → 0.0.0-0ab346a

package/badge/Badge.test.js

@@ -0,0 +1,30 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _Badge = _interopRequireDefault(require("./Badge.tsx"));
+var _Flex = _interopRequireDefault(require("../flex/Flex.tsx"));
+describe("Badge component tests", function () {
+  test("Badge renders with correct label when it is less than notification limit", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Badge["default"], {
+        label: 99,
+        mode: "notification"
+      })),
+      getByText = _render.getByText;
+    expect(getByText("99")).toBeTruthy();
+  });
+  test("Badge renders +99 as label when it is greater than notification limit", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Flex["default"], null, /*#__PURE__*/_react["default"].createElement(_Badge["default"], {
+        label: 120,
+        mode: "notification"
+      }), /*#__PURE__*/_react["default"].createElement(_Badge["default"], {
+        label: 11,
+        mode: "notification",
+        notificationLimit: 10
+      }))),
+      getByText = _render2.getByText;
+    expect(getByText("+99")).toBeTruthy();
+    expect(getByText("+10")).toBeTruthy();
+  });
+});

package/badge/types.d.ts

@@ -0,0 +1,54 @@
+/// <reference types="react" />
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+export type ContextualProps = {
+    /**
+     * Text to be placed in the badge.
+     */
+    label: string;
+    /**
+     * The available badge modes.
+     */
+    mode?: "contextual";
+    /**
+     * In notification mode, if the number entered as label is greater that this notification limit, +99 will be shown. If not, the entered text will be shown as label.
+     */
+    notificationLimit?: never;
+    /**
+     * Affects the visual style of the badge. It can be used following semantic purposes or not.
+     */
+    color?: "grey" | "blue" | "green" | "orange" | "red" | "yellow" | "purple";
+};
+export type NotificationProps = {
+    /**
+     * Text to be placed in the badge.
+     */
+    label?: number;
+    /**
+     * The available badge modes.
+     */
+    mode: "notification";
+    /**
+     * In notification mode, if the number entered as label is greater that this notification limit, +99 will be shown. If not, the entered text will be shown as label.
+     */
+    notificationLimit?: number;
+    /**
+     * Affects the visual style of the badge. It can be used following semantic purposes or not.
+     */
+    color?: never;
+};
+export type CommonProps = {
+    /**
+     * Text representing advisory information related to the badge. Under the hood, this prop also serves as an accessible label for the component.
+     */
+    title?: string;
+    /**
+     *  Material Symbol name or SVG element used as the icon that will be placed next to the badge label in contextual mode.
+     */
+    icon?: string | SVG;
+    /**
+     * Size of the component.
+     */
+    size?: "small" | "medium" | "large";
+};
+type Props = (ContextualProps | NotificationProps) & CommonProps;
+export default Props;

package/bleed/Bleed.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import BleedPropsType from "./types";
+export default function Bleed({ space, horizontal, vertical, top, right, bottom, left, children, }: BleedPropsType): JSX.Element;

package/bleed/Bleed.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = Bleed;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _react = _interopRequireDefault(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _templateObject;
+function Bleed(_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;
+  return /*#__PURE__*/_react["default"].createElement(StyledBleed, {
+    space: space,
+    horizontal: horizontal,
+    vertical: vertical,
+    top: top,
+    right: right,
+    bottom: bottom,
+    left: left
+  }, children);
+}
+function getSpacingValue(spacingName) {
+  return spacingName ? spacingName : "0rem";
+}
+var StyledBleed = _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;
+  return "\n    margin: -".concat(getSpacingValue(top || vertical || space), " -").concat(getSpacingValue(right || horizontal || space), " -").concat(getSpacingValue(bottom || vertical || space), " -").concat(getSpacingValue(left || horizontal || space), ";\n");
+});

package/bleed/Bleed.stories.tsx

@@ -0,0 +1,342 @@
+import React from "react";
+import styled from "styled-components";
+import Title from "../../.storybook/components/Title";
+import DxcBleed from "./Bleed";
+import DxcFlex from "../flex/Flex";
+
+export default {
+  title: "Bleed",
+  component: DxcBleed,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Space = none" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="0rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="0.125rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="0.25rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="0.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = small" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="1rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = medium" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="1.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = large" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="2rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="3rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="4rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Space = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed space="5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+
+    <Title title="Horizontal = none" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="0rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="0.125rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="0.25rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="0.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = small" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="1rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = medium" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="1.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = large" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="2rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="3rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="4rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Horizontal = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+
+    <Title title="Vertical = none" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="0rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="0.125rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="0.25rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="0.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = small" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="1rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = medium" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="1.5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = large" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="2rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="3rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="4rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+    <Title title="Vertical = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="5rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+
+    <Title title="Top = xsmall, right = small, bottom = medium and left = large" theme="light" level={4} />
+    <Container>
+      <DxcFlex direction="column" gap="1.5rem">
+        <Placeholder></Placeholder>
+        <DxcBleed top="0.5rem" right="1rem" bottom="1.5rem" left="2rem">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcFlex>
+    </Container>
+  </>
+);
+
+const Container = styled.div`
+  background: #f2eafa;
+  padding: 5rem;
+  margin: 2.5rem;
+`;
+
+const Placeholder = styled.div`
+  min-height: 40px;
+  min-width: 120px;
+  border: 1px solid #a46ede;
+  border-radius: 0.5rem;
+  background-color: #e5d5f6;
+`;

package/bleed/types.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="react" />
+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.
+     */
+    space?: Spacing;
+    /**
+     * Applies the spacing scale to the left and right sides.
+     */
+    horizontal?: Spacing;
+    /**
+     * Applies the spacing scale to the top and bottom sides.
+     */
+    vertical?: Spacing;
+    /**
+     * Applies the spacing scale to the top side.
+     */
+    top?: Spacing;
+    /**
+     * Applies the spacing scale to the right side.
+     */
+    right?: Spacing;
+    /**
+     * Applies the spacing scale to the bottom side.
+     */
+    bottom?: Spacing;
+    /**
+     * Applies the spacing scale to the left side.
+     */
+    left?: Spacing;
+    /**
+     * Custom content inside the bleed.
+     */
+    children: React.ReactNode;
+};
+export default Props;

package/box/Box.accessibility.test.js

@@ -0,0 +1,33 @@
+"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 _jestAxe = require("jest-axe");
+var _Box = _interopRequireDefault(require("../box/Box.tsx"));
+describe("Box 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(_Box["default"], {
+            shadowDepth: 0,
+            margin: "medium",
+            size: "small",
+            display: "flex"
+          }, "Box")), container = _render.container;
+          _context.next = 3;
+          return (0, _jestAxe.axe)(container);
+        case 3:
+          results = _context.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+});

package/box/Box.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
 import BoxPropsType from "./types";
-declare const DxcBox: ({ shadowDepth, display, children, margin, padding, size, }: BoxPropsType) => JSX.Element;
+declare const DxcBox: ({ shadowDepth, display, children, margin, size, }: BoxPropsType) => JSX.Element;
 export default DxcBox;