@dxc-technology/halstack-react 4.0.1 → 5.0.0

package/spinner/Spinner.stories.jsx

@@ -0,0 +1,103 @@
+import React from "react";
+import DxcSpinner from "./Spinner";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "Spinner",
+  component: DxcSpinner,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="With label" theme="light" level={4} />
+      <DxcSpinner label="Label" value="50"></DxcSpinner>
+      <Title title="With value label" theme="light" level={4} />
+      <DxcSpinner value="50" showValue></DxcSpinner>
+      <Title title="With label and value label" theme="light" level={4} />
+      <DxcSpinner label="Label" value="50" showValue></DxcSpinner>
+      <Title title="With 100%" theme="light" level={4} />
+      <DxcSpinner label="Label" value="100" showValue></DxcSpinner>
+    </ExampleContainer>
+    <Title title="Modes" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Mode large" theme="light" level={4} />
+      <DxcSpinner mode="large" value="50"></DxcSpinner>
+      <Title title="Mode small" theme="light" level={4} />
+      <DxcSpinner mode="small" value="50"></DxcSpinner>
+      <Title title="Mode small with 100%" theme="light" level={4} />
+      <DxcSpinner mode="small" value="100" showValue></DxcSpinner>
+    </ExampleContainer>
+    <Title title="Margins with large mode" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcSpinner margin="xxsmall" value="75"></DxcSpinner>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcSpinner margin="xsmall" value="75"></DxcSpinner>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcSpinner margin="small" value="75"></DxcSpinner>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcSpinner margin="medium" value="75"></DxcSpinner>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcSpinner margin="large" value="75"></DxcSpinner>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcSpinner margin="xlarge" value="75"></DxcSpinner>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcSpinner margin="xxlarge" value="75"></DxcSpinner>
+    </ExampleContainer>
+    <Title title="Margins with small mode" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcSpinner margin="xxsmall" mode="small" value="75"></DxcSpinner>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcSpinner margin="xsmall" mode="small" value="75"></DxcSpinner>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcSpinner margin="small" mode="small" value="75"></DxcSpinner>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcSpinner margin="medium" mode="small" value="75"></DxcSpinner>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcSpinner margin="large" mode="small" value="75"></DxcSpinner>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcSpinner margin="xlarge" mode="small" value="75"></DxcSpinner>
+      <Title title="Xxlarge margin" theme="light" level={4} />
+      <DxcSpinner margin="xxlarge" mode="small" value="75"></DxcSpinner>
+      <hr />
+    </ExampleContainer>
+  </>
+);
+
+export const SpinnerOverlay = () => (
+  <ExampleContainer>
+    <Title title="Mode overlay" theme="light" level={4} />
+    <DxcSpinner mode="overlay" value="25"></DxcSpinner>
+  </ExampleContainer>
+);
+
+export const SpinnerOverlayWith100 = () => (
+  <ExampleContainer>
+    <Title title="Mode overlay" theme="light" level={4} />
+    <DxcSpinner mode="overlay" value="100"></DxcSpinner>
+  </ExampleContainer>
+);
+
+export const SpinnerOverlayWithLabel = () => (
+  <ExampleContainer>
+    <Title title="Mode overlay" theme="light" level={4} />
+    <DxcSpinner mode="overlay" value="50" label="Label"></DxcSpinner>
+  </ExampleContainer>
+);
+
+export const SpinnerOverlayWithValue = () => (
+  <ExampleContainer>
+    <Title title="Mode overlay" theme="light" level={4} />
+    <DxcSpinner mode="overlay" value="50" showValue></DxcSpinner>
+  </ExampleContainer>
+);
+
+export const SpinnerOverlayWithValueAndLabel = () => (
+  <ExampleContainer>
+    <Title title="Mode overlay" theme="light" level={4} />
+    <DxcSpinner mode="overlay" label="Label" value="50" showValue></DxcSpinner>
+  </ExampleContainer>
+);

package/spinner/Spinner.test.js

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _Spinner = _interopRequireDefault(require("./Spinner"));
+
+describe("Spinner component tests", function () {
+  test("Spinner renders with correct label", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Spinner["default"], {
+      label: "test-loading"
+    })),
+        getByText = _render.getByText;
+
+    expect(getByText("test-loading")).toBeTruthy();
+  });
+  test("Spinner shows value correctly", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Spinner["default"], {
+      label: "test-loading",
+      value: 75,
+      showValue: true
+    })),
+        getByText = _render2.getByText;
+
+    expect(getByText("75%")).toBeTruthy();
+  });
+  test("Small spinner hides value and label correctly", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Spinner["default"], {
+      mode: "small",
+      label: "test-loading",
+      value: 75,
+      showValue: true
+    })),
+        queryByText = _render3.queryByText;
+
+    expect(queryByText("test-loading")).toBeFalsy();
+    expect(queryByText("75%")).toBeFalsy();
+  });
+  test("Overlay spinner shows value and label correctly", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Spinner["default"], {
+      mode: "overlay",
+      label: "test-loading",
+      value: 75,
+      showValue: true
+    })),
+        getByText = _render4.getByText;
+
+    expect(getByText("test-loading")).toBeTruthy();
+    expect(getByText("75%")).toBeTruthy();
+  });
+  test("Get spinner by role", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Spinner["default"], {
+      label: "test-loading",
+      value: 75,
+      showValue: true
+    })),
+        getByRole = _render5.getByRole;
+
+    expect(getByRole("progressbar")).toBeTruthy();
+  });
+});

package/spinner/types.d.ts

@@ -0,0 +1,32 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Text to be placed inside the spinner.
+     */
+    label?: string;
+    /**
+     * The value of the progress indicator. If it's received the
+     * component is determinate, otherwise is indeterminate.
+     */
+    value?: number;
+    /**
+     * If true, the value is displayed inside the spinner..
+     */
+    showValue?: boolean;
+    /**
+     * Available modes of the spinner.
+     */
+    mode?: "large" | "small" | "overlay";
+    /**
+     * 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;
+};
+export default Props;

package/spinner/types.js

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

package/stack/Stack.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import StackPropsType from "./types";
+export default function Stack({ gutter, divider, align, as, children }: StackPropsType): JSX.Element;

package/stack/Stack.js

@@ -0,0 +1,97 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = Stack;
+
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _styledComponents = _interopRequireDefault(require("styled-components"));
+
+var _templateObject, _templateObject2;
+
+function Stack(_ref) {
+  var gutter = _ref.gutter,
+      divider = _ref.divider,
+      align = _ref.align,
+      _ref$as = _ref.as,
+      as = _ref$as === void 0 ? "div" : _ref$as,
+      children = _ref.children;
+  return /*#__PURE__*/_react["default"].createElement(StyledStack, {
+    gutter: gutter,
+    divider: divider,
+    align: align,
+    as: as
+  }, _react["default"].Children.map(children, function (child, index) {
+    return /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, child, divider && index !== _react["default"].Children.count(children) - 1 && /*#__PURE__*/_react["default"].createElement(Divider, null));
+  }));
+}
+
+var Divider = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  height: 1px;\n  background-color: #999999;\n"])));
+
+var StyledStack = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n  align-items: ", ";\n  gap: ", ";\n  margin: 0;\n  padding: 0;\n"])), function (_ref2) {
+  var align = _ref2.align;
+
+  switch (align) {
+    case "start":
+      return "flex-start";
+
+    case "center":
+      return "center";
+
+    case "end":
+      return "flex-end";
+
+    case "baseline":
+      return "baseline";
+
+    case "stretch":
+      return "stretch";
+
+    default:
+      return "initial";
+  }
+}, function (_ref3) {
+  var gutter = _ref3.gutter,
+      divider = _ref3.divider;
+
+  switch (gutter) {
+    case "none":
+      return "0";
+
+    case "xxxsmall":
+      return "calc(0.125rem / ".concat(divider ? 2 : 1, ")");
+
+    case "xxsmall":
+      return "calc(0.25rem / ".concat(divider ? 2 : 1, ")");
+
+    case "xsmall":
+      return "calc(0.5rem / ".concat(divider ? 2 : 1, ")");
+
+    case "small":
+      return "calc(1rem / ".concat(divider ? 2 : 1, ")");
+
+    case "medium":
+      return "calc(1.5rem / ".concat(divider ? 2 : 1, ")");
+
+    case "large":
+      return "calc(2rem / ".concat(divider ? 2 : 1, ")");
+
+    case "xlarge":
+      return "calc(3rem / ".concat(divider ? 2 : 1, ")");
+
+    case "xxlarge":
+      return "calc(4rem / ".concat(divider ? 2 : 1, ")");
+
+    case "xxxlarge":
+      return "calc(5rem / ".concat(divider ? 2 : 1, ")");
+
+    default:
+      return "0";
+  }
+});

package/stack/Stack.stories.tsx

@@ -0,0 +1,164 @@
+import React from "react";
+import Title from "../../.storybook/components/Title";
+import styled from "styled-components";
+import DxcStack from "./Stack";
+
+export default {
+  title: "Stack",
+  component: DxcStack,
+};
+
+export const Chromatic = () => (
+  <>
+    <Title title="Default" theme="light" level={4} />
+    <Container>
+      <DxcStack>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Align = baseline" theme="light" level={4} />
+    <Container>
+      <DxcStack align="baseline">
+        <Placeholder paddingLeft={20}></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder paddingRight={60}></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Align = center" theme="light" level={4} />
+    <Container>
+      <DxcStack align="center">
+        <Placeholder paddingLeft={20}></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder paddingLeft={60}></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Align = end" theme="light" level={4} />
+    <Container>
+      <DxcStack align="end">
+        <Placeholder paddingLeft={20}></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder paddingLeft={60}></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Align = start" theme="light" level={4} />
+    <Container>
+      <DxcStack align="start">
+        <Placeholder paddingLeft={20}></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder paddingLeft={60}></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="Align = stretch" theme="light" level={4} />
+    <Container>
+      <DxcStack align="stretch">
+        <Placeholder paddingLeft={20}></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder paddingLeft={60}></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xxxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xxxsmall">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xxsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xxsmall">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xsmall" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xsmall">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = small" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="small">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = medium" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="medium">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = large" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="large">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xlarge">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xxlarge">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xxxlarge" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xxxlarge">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = xxlarge && divider" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="xxlarge" divider>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+    <Title title="gutter = none" theme="light" level={4} />
+    <Container>
+      <DxcStack gutter="none">
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+        <Placeholder></Placeholder>
+      </DxcStack>
+    </Container>
+  </>
+);
+
+const Container = styled.div`
+  background: #f2eafa;
+  padding: 10px;
+`;
+
+const Placeholder = styled.div`
+  min-height: 40px;
+  min-width: 120px;
+  border: 1px solid #a46ede;
+  background-color: #e5d5f6;
+  padding-left: ${({ paddingLeft }) => `${paddingLeft ?? 0}px`};
+  padding-right: ${({ paddingRight }) => `${paddingRight ?? 0}px`};
+`;

package/stack/types.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+declare type Props = {
+    /**
+     * Space applied between each child.
+     */
+    gutter?: "none" | "xxxsmall" | "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge" | "xxxlarge";
+    /**
+     * If true, a divider is shown between children.
+     */
+    divider?: boolean;
+    /**
+     * Alignment applied to children.
+     */
+    align?: "start" | "center" | "end" | "baseline" | "stretch";
+    /**
+     * Specifies the HTML tag or component that is rendered as the wrapper element.
+     */
+    as?: React.ElementType;
+    /**
+     * Custom content inside the stack.
+     */
+    children: React.ReactNode;
+};
+export default Props;

package/stack/types.js

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

package/switch/Switch.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import SwitchPropsType from "./types";
+declare const DxcSwitch: ({ defaultChecked, checked, value, label, labelPosition, name, disabled, optional, onChange, margin, size, tabIndex, }: SwitchPropsType) => JSX.Element;
+export default DxcSwitch;