@dxc-technology/halstack-react 0.0.0-951bb80 → 0.0.0-95b953e

package/badge/Badge.stories.tsx

@@ -0,0 +1,210 @@
+import React from "react";
+import DxcBadge from "./Badge";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import DxcFlex from "../flex/Flex";
+
+export default {
+  title: "Badge",
+  component: DxcBadge,
+};
+
+const icon = (
+  <svg width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="currentColor">
+    <path d="M11 17H13V11H11V17ZM12 2C6.48 2 2 6.48 2 12C2 17.52 6.48 22 12 22C17.52 22 22 17.52 22 12C22 6.48 17.52 2 12 2ZM12 20C7.59 20 4 16.41 4 12C4 7.59 7.59 4 12 4C16.41 4 20 7.59 20 12C20 16.41 16.41 20 12 20ZM11 9H13V7H11V9Z" />
+    <path d="M11 7H13V9H11V7ZM11 11H13V17H11V11Z" />
+    <path d="M12 2C6.48 2 2 6.48 2 12C2 17.52 6.48 22 12 22C17.52 22 22 17.52 22 12C22 6.48 17.52 2 12 2ZM12 20C7.59 20 4 16.41 4 12C4 7.59 7.59 4 12 4C16.41 4 20 7.59 20 12C20 16.41 16.41 20 12 20Z" />
+  </svg>
+);
+
+export const Chromatic = () => (
+  <>
+    <Title title="Notification" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge mode="notification" size="small" />
+        <DxcBadge mode="notification" label={1} size="small" />
+        <DxcBadge mode="notification" label={10} size="small" />
+        <DxcBadge mode="notification" label={1000000} size="small" notificationLimit={99999999} />
+        <DxcBadge mode="notification" label={100} size="small" notificationLimit={99} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignContent="center" alignItems="center">
+        <DxcBadge mode="notification" size="medium" />
+        <DxcBadge mode="notification" label={1} size="medium" />
+        <DxcBadge mode="notification" label={10} size="medium" />
+        <DxcBadge mode="notification" label={1000000} size="medium" notificationLimit={99999999} />
+        <DxcBadge mode="notification" label={100} size="medium" />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge mode="notification" size="large" />
+        <DxcBadge mode="notification" label={1} size="large" />
+        <DxcBadge mode="notification" label={10} size="large" />
+        <DxcBadge mode="notification" label={1000000} size="large" notificationLimit={99999999} />
+        <DxcBadge mode="notification" label={100} size="large" />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Contextual" theme="light" level={2} />
+    <Title title="Grey" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge label="Label" size="small" />
+        <DxcBadge label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge label="Label" />
+        <DxcBadge label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge label="Label" size="large" />
+        <DxcBadge label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Blue" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="blue" label="Label" size="small" />
+        <DxcBadge color="blue" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="blue" label="Label" />
+        <DxcBadge color="blue" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="blue" label="Label" size="large" />
+        <DxcBadge color="blue" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Green" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="green" label="Label" size="small" />
+        <DxcBadge color="green" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="green" label="Label" />
+        <DxcBadge color="green" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="green" label="Label" size="large" />
+        <DxcBadge color="green" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer></ExampleContainer>
+    <Title title="Orange" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="orange" label="Label" size="small" />
+        <DxcBadge color="orange" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="orange" label="Label" />
+        <DxcBadge color="orange" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="orange" label="Label" size="large" />
+        <DxcBadge color="orange" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Red" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="red" label="Label" size="small" />
+        <DxcBadge color="red" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="red" label="Label" />
+        <DxcBadge color="red" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="red" label="Label" size="large" />
+        <DxcBadge color="red" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Yellow" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="yellow" label="Label" size="small" />
+        <DxcBadge color="yellow" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="yellow" label="Label" />
+        <DxcBadge color="yellow" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="yellow" label="Label" size="large" />
+        <DxcBadge color="yellow" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <Title title="Purple" theme="light" level={3} />
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="purple" label="Label" size="small" />
+        <DxcBadge color="purple" label="Label" size="small" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="purple" label="Label" />
+        <DxcBadge color="purple" label="Label" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcFlex gap="3rem" alignItems="center">
+        <DxcBadge color="purple" label="Label" size="large" />
+        <DxcBadge color="purple" label="Label" size="large" icon={icon} />
+      </DxcFlex>
+    </ExampleContainer>
+  </>
+);

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>;
+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";
+};
+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;
+};
+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;
+    /**
+     * Element or path 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.js

@@ -1,29 +1,23 @@
 "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;
+    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,
@@ -34,51 +28,16 @@ function Bleed(_ref) {
     left: left
   }, children);
 }
-
 function getSpacingValue(spacingName) {
-  switch (spacingName) {
-    case "none":
-      return "0rem";
-
-    case "xxxsmall":
-      return "0.125rem";
-
-    case "xxsmall":
-      return "0.25rem";
-
-    case "xsmall":
-      return "0.5rem";
-
-    case "small":
-      return "1rem";
-
-    case "medium":
-      return "1.5rem";
-
-    case "large":
-      return "2rem";
-
-    case "xlarge":
-      return "3rem";
-
-    case "xxlarge":
-      return "4rem";
-
-    case "xxxlarge":
-      return "5rem";
-
-    default:
-      return "0rem";
-  }
+  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;
+    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");
 });