@dxc-technology/halstack-react 3.4.1 → 5.0.0

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 }: BadgePropsType) => JSX.Element;
+export default DxcBadge;

package/badge/Badge.js

@@ -0,0 +1,59 @@
+"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;
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.tabs
+  }, /*#__PURE__*/_react["default"].createElement(StyledDxcBadge, {
+    notificationText: notificationText
+  }, /*#__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.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,4 @@
+declare type Props = {
+    notificationText: boolean | number | string;
+};
+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,84 @@
+"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) {
+  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";
+  }
+}
+
+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 DxcStack from "../stack/Stack";
+
+export default {
+  title: "Bleed",
+  component: DxcBleed,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Space = none" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="none">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xxxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = small" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="small">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = medium" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="medium">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = large" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="large">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Space = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed space="xxxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+
+    <Title title="Horizontal = none" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="none">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xxxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = small" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="small">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = medium" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="medium">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = large" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="large">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Horizontal = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed horizontal="xxxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+
+    <Title title="Vertical = none" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="none">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xxxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xxsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xsmall">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = small" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="small">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = medium" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="medium">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = large" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="large">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Vertical = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed vertical="xxxlarge">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+
+    <Title title="Top = xsmall, right = small, bottom = medium and left = large" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <DxcBleed top="xsmall" right="small" bottom="medium" left="large">
+          <Placeholder></Placeholder>
+        </DxcBleed>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </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;
+  background-color: #e5d5f6;
+`;
+

package/bleed/types.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="react" />
+declare type Spacing = "none" | "xxxsmall" | "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge" | "xxxlarge";
+declare 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/bleed/types.js

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

package/box/Box.d.ts

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