@dxc-technology/halstack-react 0.0.0-c7d5596 → 0.0.0-c83579c

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,92 @@
+"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" />
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare 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 hidding 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";
+    /**
+     * Tabindex value given 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: ({ notificationText, disabled }: BadgePropsType) => JSX.Element;
+export default DxcBadge;

package/badge/Badge.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+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 = _interopRequireWildcard(require("styled-components"));
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _templateObject;
+
+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 || _typeof(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 DxcBadge = function DxcBadge(_ref) {
+  var notificationText = _ref.notificationText,
+      disabled = _ref.disabled;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.tabs
+  }, /*#__PURE__*/_react["default"].createElement(StyledDxcBadge, {
+    notificationText: notificationText,
+    disabled: disabled
+  }, /*#__PURE__*/_react["default"].createElement("span", null, notificationText)));
+};
+
+var StyledDxcBadge = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  background-color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  letter-spacing: ", ";\n  width: ", ";\n  height: ", ";\n  border-radius: ", ";\n  display: flex;\n  padding-bottom: 1px;\n  padding-right: 1px;\n  flex-wrap: wrap;\n  box-sizing: border-box;\n  align-items: center;\n  line-height: 1;\n  align-content: center;\n  flex-direction: row;\n  justify-content: center;\n"])), function (props) {
+  return props.disabled ? props.theme.disabledBadgeBackgroundColor : props.theme.badgeBackgroundColor;
+}, function (props) {
+  return props.theme.badgeFontFamily;
+}, function (props) {
+  return props.theme.badgeFontSize;
+}, function (props) {
+  return props.theme.badgeFontStyle;
+}, function (props) {
+  return props.theme.badgeFontWeight;
+}, function (props) {
+  return props.theme.badgeFontColor;
+}, function (props) {
+  return props.theme.badgeLetterSpacing;
+}, function (props) {
+  return props.notificationText === true ? props.theme.badgeWidth : props.theme.badgeWidthWithNotificationNumber;
+}, function (props) {
+  return props.notificationText === true ? props.theme.badgeHeight : props.theme.badgeHeightWithNotificationNumber;
+}, function (props) {
+  return props.notificationText === true ? props.theme.badgeRadius : props.theme.badgeRadiusWithNotificationNumber;
+});
+
+var _default = DxcBadge;
+exports["default"] = _default;

package/badge/types.d.ts

@@ -0,0 +1,5 @@
+declare type Props = {
+    notificationText: boolean | number | string;
+    disabled?: boolean;
+};
+export default Props;

package/badge/types.js

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

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,51 @@
+"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");
+});