@dxc-technology/halstack-react 0.0.0-5b2ad05 → 0.0.0-5b32837

package/alert/Alert.stories.tsx

@@ -0,0 +1,198 @@
+import React from "react";
+import DxcAlert from "./Alert";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
+
+export default {
+  title: "Alert",
+  component: DxcAlert,
+};
+
+const opinionatedTheme = {
+  alert: {
+    baseColor: "#e6f4ff",
+    accentColor: "#0067b3",
+    overlayColor: "#000000b3",
+  },
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Info" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Confirm" theme="light" level={4} />
+      <DxcAlert type="confirm" inlineText="Confirm type alert with inline text." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Warning" theme="light" level={4} />
+      <DxcAlert type="warning" inlineText="Warning type alert with inline text." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Error" theme="light" level={4} />
+      <DxcAlert type="error" inlineText="Error type alert with inline text." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With close button" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text and close button." onClose={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-hover">
+      <Title title="With hovered close button" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text and close button." onClose={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-focus">
+      <Title title="With focused close button" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text and close button." onClose={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer pseudoState="pseudo-active">
+      <Title title="With actived close button" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text and close button." onClose={() => {}} />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With children" theme="light" level={4} />
+      <DxcAlert>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="With inline text and children" theme="light" level={4} />
+      <DxcAlert inlineText="Info type alert with inline text.">
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall" theme="light" level={4} />
+      <DxcAlert margin="xxsmall" inlineText="Info type alert with inline text and xxsmall margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall" theme="light" level={4} />
+      <DxcAlert margin="xsmall" inlineText="Info type alert with inline text and xsmall margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcAlert margin="small" inlineText="Info type alert with inline text and small margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcAlert margin="medium" inlineText="Info type alert with inline text and medium margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcAlert margin="large" inlineText="Info type alert with inline text and large margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge" theme="light" level={4} />
+      <DxcAlert margin="xlarge" inlineText="Info type alert with inline text and xlarge margin." />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xxlarge" theme="light" level={4} />
+      <DxcAlert margin="xxlarge" inlineText="Info type alert with inline text and xxlarge margin." />
+    </ExampleContainer>
+    <Title title="Sizes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="FitContent" theme="light" level={4} />
+      <DxcAlert
+        size="fitContent"
+        inlineText="Info type alert with inline text, children, close button and fitContent size."
+        onClose={() => {}}
+      >
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small" theme="light" level={4} />
+      <DxcAlert
+        size="small"
+        inlineText="Info type alert with inline text, children, close button and small size."
+        onClose={() => {}}
+      >
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium" theme="light" level={4} />
+      <DxcAlert
+        size="medium"
+        inlineText="Info type alert with inline text, children, close button and medium size."
+        onClose={() => {}}
+      >
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large" theme="light" level={4} />
+      <DxcAlert
+        size="large"
+        inlineText="Info type alert with inline text, children, close button and large size."
+        onClose={() => {}}
+      >
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="FillParent" theme="light" level={4} />
+      <DxcAlert
+        size="fillParent"
+        inlineText="Info type alert with inline text, children, close button and fillParent size."
+        onClose={() => {}}
+      >
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcAlert inlineText="Info type alert with inline text." />
+      </HalstackProvider>
+    </ExampleContainer>
+  </>
+);
+
+export const ModalAlert = () => (
+  <ExampleContainer>
+    <DxcAlert inlineText="Modal alert." mode="modal" onClose={() => {}}>
+      <div>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+        lobortis eget.
+      </div>
+    </DxcAlert>
+  </ExampleContainer>
+);
+
+export const ModalAlertOpinionated = () => (
+  <ExampleContainer>
+    <HalstackProvider theme={opinionatedTheme}>
+      <DxcAlert inlineText="Modal alert." mode="modal" onClose={() => {}}>
+        <div>
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse malesuada lacus ex, sit amet blandit leo
+          lobortis eget.
+        </div>
+      </DxcAlert>
+    </HalstackProvider>
+  </ExampleContainer>
+);

package/alert/Alert.test.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _Alert = _interopRequireDefault(require("./Alert.tsx"));
+describe("Alert component tests", function () {
+  test("Info alert renders with correct text", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        type: "info",
+        inlineText: "info-alert-text"
+      })),
+      getByText = _render.getByText;
+    expect(getByText("information")).toBeTruthy();
+    expect(getByText("info-alert-text")).toBeTruthy();
+  });
+  test("Confirm alert renders with correct text", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        type: "confirm",
+        inlineText: "confirm-alert-text"
+      })),
+      getByText = _render2.getByText;
+    expect(getByText("success")).toBeTruthy();
+    expect(getByText("confirm-alert-text")).toBeTruthy();
+  });
+  test("Warning alert renders with correct text", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        type: "warning",
+        inlineText: "warning-alert-text"
+      })),
+      getByText = _render3.getByText;
+    expect(getByText("warning")).toBeTruthy();
+    expect(getByText("warning-alert-text")).toBeTruthy();
+  });
+  test("Error alert renders with correct text", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        type: "error",
+        inlineText: "error-alert-text"
+      })),
+      getByText = _render4.getByText;
+    expect(getByText("error")).toBeTruthy();
+    expect(getByText("error-alert-text")).toBeTruthy();
+  });
+  test("Alert renders with correct children", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        inlineText: "alert-text"
+      }, /*#__PURE__*/_react["default"].createElement("p", null, "sample-children"))),
+      getByText = _render5.getByText;
+    expect(getByText("alert-text")).toBeTruthy();
+    expect(getByText("sample-children")).toBeTruthy();
+  });
+  test("Calls correct function on close", function () {
+    var onClose = jest.fn();
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        onClose: onClose,
+        inlineText: "info-alert-text"
+      })),
+      getByRole = _render6.getByRole;
+    var closeButton = getByRole("button");
+    _react2.fireEvent.click(closeButton);
+    expect(onClose).toHaveBeenCalled();
+  });
+  test("Modal alert calls correct function on close", function () {
+    var onClose = jest.fn();
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Alert["default"], {
+        onClose: onClose,
+        mode: "modal",
+        inlineText: "info-alert-text"
+      })),
+      getByRole = _render7.getByRole;
+    var closeButton = getByRole("button");
+    _react2.fireEvent.click(closeButton);
+    expect(onClose).toHaveBeenCalled();
+  });
+});

package/alert/types.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="react" />
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+type Props = {
+    /**
+     * Uses on of the available alert types.
+     */
+    type?: "info" | "confirm" | "warning" | "error";
+    /**
+     * Uses on of the available alert modes:
+     *    'inline': If onClose function is received, close button will be visible and the function will be executed when it's clicked.
+     *              There is no overlay layer. Position should be decided by the user.
+     *    'modal':  The alert will be displayed in the middle of the screen with an overlay layer behind.
+     *              The onClose function will be executed when the X button or the overlay is clicked. d
+     *              The user has the responsibility of hiding the modal in the onClose function, otherwise the modal will remain visible.
+     */
+    mode?: "inline" | "modal";
+    /**
+     * Text to display after icon and alert type and before content.
+     */
+    inlineText?: string;
+    /**
+     * This function will be called when the user clicks the close button. If there is no function we should close the alert by default.
+     */
+    onClose?: () => void;
+    /**
+     * The details section of the alert. Can be used to render custom content in this area.
+     */
+    children?: React.ReactNode;
+    /**
+     * 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 applied to the close button.
+     */
+    tabIndex?: number;
+};
+export default Props;

package/alert/types.js

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

package/badge/Badge.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import BadgePropsType from "./types";
+declare const DxcBadge: ({ label, title, mode, color, icon, notificationLimit, size, }: BadgePropsType) => JSX.Element;
+export default DxcBadge;

package/badge/Badge.js

@@ -0,0 +1,159 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _react = _interopRequireDefault(require("react"));
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+var _Flex = _interopRequireDefault(require("../flex/Flex"));
+var _coreTokens = _interopRequireDefault(require("../common/coreTokens"));
+var _templateObject, _templateObject2, _templateObject3;
+var contextualColorMap = {
+  grey: {
+    background: _coreTokens["default"].color_grey_200,
+    text: _coreTokens["default"].color_grey_900
+  },
+  blue: {
+    background: _coreTokens["default"].color_blue_200,
+    text: _coreTokens["default"].color_blue_900
+  },
+  green: {
+    background: _coreTokens["default"].color_green_200,
+    text: _coreTokens["default"].color_green_900
+  },
+  orange: {
+    background: _coreTokens["default"].color_orange_200,
+    text: _coreTokens["default"].color_orange_900
+  },
+  red: {
+    background: _coreTokens["default"].color_red_200,
+    text: _coreTokens["default"].color_red_900
+  },
+  yellow: {
+    background: _coreTokens["default"].color_yellow_200,
+    text: _coreTokens["default"].color_yellow_900
+  },
+  purple: {
+    background: _coreTokens["default"].color_purple_200,
+    text: _coreTokens["default"].color_purple_900
+  }
+};
+var sizeMap = {
+  small: {
+    height: "20px",
+    width: "20px",
+    minWidth: "20px",
+    fontSize: _coreTokens["default"].type_scale_01,
+    borderRadius: _coreTokens["default"].spacing_12,
+    iconSize: "14px",
+    padding: {
+      contextual: "".concat(_coreTokens["default"].spacing_4),
+      notification: "".concat(_coreTokens["default"].spacing_0, " ").concat(_coreTokens["default"].spacing_4)
+    }
+  },
+  medium: {
+    height: "24px",
+    width: "24px",
+    minWidth: "24px",
+    fontSize: _coreTokens["default"].type_scale_02,
+    borderRadius: _coreTokens["default"].spacing_12,
+    iconSize: "16px",
+    padding: {
+      contextual: "".concat(_coreTokens["default"].spacing_4, " ").concat(_coreTokens["default"].spacing_8),
+      notification: "".concat(_coreTokens["default"].spacing_0, " ").concat(_coreTokens["default"].spacing_4)
+    }
+  },
+  large: {
+    height: "32px",
+    width: "32px",
+    minWidth: "32px",
+    fontSize: _coreTokens["default"].type_scale_04,
+    borderRadius: _coreTokens["default"].spacing_24,
+    iconSize: "24px",
+    padding: {
+      contextual: "".concat(_coreTokens["default"].spacing_4, " ").concat(_coreTokens["default"].spacing_8),
+      notification: "".concat(_coreTokens["default"].spacing_0, " ").concat(_coreTokens["default"].spacing_8)
+    }
+  }
+};
+var Label = function Label(_ref) {
+  var label = _ref.label,
+    notificationLimit = _ref.notificationLimit,
+    size = _ref.size;
+  return /*#__PURE__*/_react["default"].createElement(LabelContainer, {
+    size: size
+  }, typeof label === "number" ? label > notificationLimit ? "+" + notificationLimit : label : label);
+};
+var DxcBadge = function DxcBadge(_ref2) {
+  var label = _ref2.label,
+    title = _ref2.title,
+    _ref2$mode = _ref2.mode,
+    mode = _ref2$mode === void 0 ? "contextual" : _ref2$mode,
+    _ref2$color = _ref2.color,
+    color = _ref2$color === void 0 ? "grey" : _ref2$color,
+    icon = _ref2.icon,
+    _ref2$notificationLim = _ref2.notificationLimit,
+    notificationLimit = _ref2$notificationLim === void 0 ? 99 : _ref2$notificationLim,
+    _ref2$size = _ref2.size,
+    size = _ref2$size === void 0 ? "medium" : _ref2$size;
+  return /*#__PURE__*/_react["default"].createElement(BadgeContainer, {
+    label: label,
+    mode: mode,
+    color: mode === "contextual" && color || undefined,
+    size: size,
+    title: title,
+    "aria-label": title
+  }, mode === "contextual" && /*#__PURE__*/_react["default"].createElement(_Flex["default"], {
+    gap: "0.125rem",
+    alignItems: "center"
+  }, icon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    size: size
+  }, typeof icon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+    src: icon,
+    alt: title
+  }) : icon), /*#__PURE__*/_react["default"].createElement(Label, {
+    label: label,
+    notificationLimit: notificationLimit,
+    size: size
+  })) || /*#__PURE__*/_react["default"].createElement(Label, {
+    label: label,
+    notificationLimit: notificationLimit,
+    size: size
+  }));
+};
+var getColor = function getColor(mode, color) {
+  return mode === "contextual" ? contextualColorMap[color].text : _coreTokens["default"].color_white;
+};
+var getBackgroundColor = function getBackgroundColor(mode, color) {
+  return mode === "contextual" ? contextualColorMap[color].background : _coreTokens["default"].color_red_700;
+};
+var getPadding = function getPadding(mode, size) {
+  return mode === "contextual" ? sizeMap[size].padding.contextual : sizeMap[size].padding.notification;
+};
+var BadgeContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  color: ", ";\n  background-color: ", ";\n  border-radius: ", ";\n  width: ", ";\n  min-width: ", ";\n  height: ", ";\n  padding: ", ";\n  align-items: center;\n  justify-content: center;\n  box-sizing: border-box;\n"])), function (props) {
+  return getColor(props.mode, props.color);
+}, function (props) {
+  return getBackgroundColor(props.mode, props.color);
+}, function (props) {
+  return sizeMap[props.size].borderRadius;
+}, function (props) {
+  return !props.label && props.mode === "notification" ? sizeMap[props.size].width : "fit-content";
+}, function (props) {
+  return props.mode === "notification" && sizeMap[props.size].minWidth;
+}, function (props) {
+  return sizeMap[props.size].height;
+}, function (props) {
+  return props.label ? getPadding(props.mode, props.size) : "";
+});
+var IconContainer = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  img,\n  svg {\n    height: ", ";\n    width: ", ";\n  }\n"])), function (props) {
+  return sizeMap[props.size].iconSize;
+}, function (props) {
+  return sizeMap[props.size].iconSize;
+});
+var LabelContainer = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  font-family: ", ";\n  font-size: ", ";\n  font-weight: ", ";\n  white-space: nowrap;\n"])), _coreTokens["default"].type_sans, function (props) {
+  return sizeMap[props.size].fontSize;
+}, _coreTokens["default"].type_semibold);
+var _default = exports["default"] = DxcBadge;