@dxc-technology/halstack-react 0.0.0-2b5b4b0 → 0.0.0-2bca710

package/spinner/Spinner.js

@@ -13,19 +13,15 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _react = _interopRequireWildcard(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _variables = require("../common/variables.js");
+var _variables = require("../common/variables");
 
-var _useTheme = _interopRequireDefault(require("../useTheme.js"));
+var _useTheme = _interopRequireDefault(require("../useTheme"));
 
-var _BackgroundColorContext = _interopRequireDefault(require("../BackgroundColorContext.js"));
+var _BackgroundColorContext = _interopRequireDefault(require("../BackgroundColorContext"));
 
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9, _templateObject10, _templateObject11, _templateObject12;
 
@@ -50,11 +46,8 @@ var DxcSpinner = function DxcSpinner(_ref) {
     margin: margin,
     mode: mode
   }, /*#__PURE__*/_react["default"].createElement(SpinnerContainer, {
-    backgroundType: backgroundType,
-    mode: mode
-  }, mode === "overlay" && /*#__PURE__*/_react["default"].createElement(BackOverlay, null), /*#__PURE__*/_react["default"].createElement(BackgroundSpinner, {
     mode: mode
-  }, mode !== "small" && /*#__PURE__*/_react["default"].createElement(SVGBackground, {
+  }, mode === "overlay" && /*#__PURE__*/_react["default"].createElement(BackOverlay, null), /*#__PURE__*/_react["default"].createElement(BackgroundSpinner, null, mode !== "small" && /*#__PURE__*/_react["default"].createElement(SVGBackground, {
     viewBox: "0 0 140 140"
   }, /*#__PURE__*/_react["default"].createElement(CircleBackground, {
     cx: "70",
@@ -69,8 +62,7 @@ var DxcSpinner = function DxcSpinner(_ref) {
     r: "6",
     mode: mode
   }))), value >= 0 && value <= 100 ? /*#__PURE__*/_react["default"].createElement(Spinner, {
-    role: "progressbar",
-    mode: mode
+    role: "progressbar"
   }, mode !== "small" && /*#__PURE__*/_react["default"].createElement(SVGSpinner, {
     viewBox: "0 0 140 140",
     isDeterminated: true
@@ -94,8 +86,7 @@ var DxcSpinner = function DxcSpinner(_ref) {
     isDeterminated: true,
     value: value
   }))) : /*#__PURE__*/_react["default"].createElement(Spinner, {
-    role: "progressbar",
-    mode: mode
+    role: "progressbar"
   }, mode !== "small" && /*#__PURE__*/_react["default"].createElement(SVGSpinner, {
     viewBox: "0 0 140 140",
     isDeterminated: false
@@ -105,7 +96,8 @@ var DxcSpinner = function DxcSpinner(_ref) {
     r: "65",
     backgroundType: backgroundType,
     mode: mode,
-    isDeterminated: false
+    isDeterminated: false,
+    value: value
   })), mode === "small" && /*#__PURE__*/_react["default"].createElement(SVGSpinner, {
     viewBox: "0 0 16 16",
     isDeterminated: false
@@ -115,44 +107,29 @@ var DxcSpinner = function DxcSpinner(_ref) {
     r: "6",
     backgroundType: backgroundType,
     mode: mode,
-    isDeterminated: false
-  }))), mode !== "small" && /*#__PURE__*/_react["default"].createElement(LabelsContainer, {
-    label: label,
-    value: value,
-    showValue: showValue
-  }, /*#__PURE__*/_react["default"].createElement(SpinnerLabel, {
+    isDeterminated: false,
+    value: value
+  }))), mode !== "small" && /*#__PURE__*/_react["default"].createElement(LabelsContainer, null, /*#__PURE__*/_react["default"].createElement(SpinnerLabel, {
     backgroundType: backgroundType,
     mode: mode
   }, label), (value || value === 0) && showValue && /*#__PURE__*/_react["default"].createElement(SpinnerProgress, {
+    value: value,
     backgroundType: backgroundType,
     mode: mode,
     showValue: showValue
   }, value, "%")))));
 };
 
-var determinatedValue = function determinatedValue(props, strokeDashArray) {
+var determinatedValue = function determinatedValue(value, strokeDashArray) {
   var val = 0;
 
-  if (props.value >= 0 && props.value <= 100) {
-    val = strokeDashArray * (1 - props.value / 100);
+  if (value >= 0 && value <= 100) {
+    val = strokeDashArray * (1 - value / 100);
   }
 
   return val;
 };
 
-DxcSpinner.propTypes = {
-  label: _propTypes["default"].string,
-  value: _propTypes["default"].number,
-  showValue: _propTypes["default"].bool,
-  mode: _propTypes["default"].oneOf(["large", "small", "overlay"]),
-  margin: _propTypes["default"].oneOfType([_propTypes["default"].shape({
-    top: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    bottom: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    left: _propTypes["default"].oneOf(Object.keys(_variables.spaces)),
-    right: _propTypes["default"].oneOf(Object.keys(_variables.spaces))
-  }), _propTypes["default"].oneOf((0, _toConsumableArray2["default"])(Object.keys(_variables.spaces)))])
-};
-
 var DXCSpinner = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  height: ", ";\n  width: ", ";\n  display: ", ";\n  position: ", ";\n  top: ", ";\n  left: ", ";\n  justify-content: ", ";\n  align-items: ", ";\n  z-index: ", ";\n\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n"])), function (props) {
   return props.mode === "overlay" ? "100vh" : "";
 }, function (props) {
@@ -195,7 +172,7 @@ var BackOverlay = _styledComponents["default"].div(_templateObject3 || (_templat
   return "".concat(props.theme.overlayOpacity);
 });
 
-var BackgroundSpinner = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n  position: absolute;\n  z-index: 1;\n"])));
+var BackgroundSpinner = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n  position: absolute;\n"])));
 
 var SVGBackground = _styledComponents["default"].svg(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n"])));
 
@@ -207,7 +184,7 @@ var CircleBackground = _styledComponents["default"].circle(_templateObject6 || (
   return props.mode !== "small" ? "8.5px" : "2px";
 });
 
-var Spinner = _styledComponents["default"].div(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n  position: relative;\n  z-index: 2;\n"])));
+var Spinner = _styledComponents["default"].div(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n  position: relative;\n"])));
 
 var SVGSpinner = _styledComponents["default"].svg(_templateObject8 || (_templateObject8 = (0, _taggedTemplateLiteral2["default"])(["\n  height: inherit;\n  width: inherit;\n  transform: rotate(-90deg);\n  top: 0;\n  left: 0;\n  transform-origin: center;\n  overflow: visible;\n  animation: ", ";\n"])), function (props) {
   return !props.isDeterminated ? "1.4s linear infinite both spinner-svg" : "";
@@ -216,7 +193,7 @@ var SVGSpinner = _styledComponents["default"].svg(_templateObject8 || (_template
 var CircleSpinner = _styledComponents["default"].circle(_templateObject9 || (_templateObject9 = (0, _taggedTemplateLiteral2["default"])(["\n  fill: transparent;\n  stroke-linecap: initial;\n  vector-effect: non-scaling-stroke;\n  animation: ", ";\n  stroke: ", ";\n  transform-origin: ", ";\n  stroke-dasharray: ", ";\n  stroke-width: ", ";\n  stroke-dashoffset: ", ";\n"])), function (props) {
   return props.isDeterminated ? "none" : props.mode !== "small" ? "1.4s ease-in-out infinite both svg-circle-large" : "1.4s ease-in-out infinite both svg-circle-small";
 }, function (props) {
-  return props.backgroundType === "dark" ? props.theme.trackCircleColorOnDark : props.theme.trackCircleColor;
+  return props.backgroundType === "dark" || props.mode === "overlay" ? props.theme.trackCircleColorOverlay : props.theme.trackCircleColor;
 }, function (props) {
   return !props.isDeterminated ? "50% 50%" : "";
 }, function (props) {
@@ -224,7 +201,7 @@ var CircleSpinner = _styledComponents["default"].circle(_templateObject9 || (_te
 }, function (props) {
   return props.mode !== "small" ? "8.5px" : "2px";
 }, function (props) {
-  return props.isDeterminated ? props.mode !== "small" ? determinatedValue(props, 409) : determinatedValue(props, 38) : "";
+  return props.isDeterminated ? props.mode !== "small" ? determinatedValue(props.value, 409) : determinatedValue(props.value, 38) : "";
 });
 
 var LabelsContainer = _styledComponents["default"].div(_templateObject10 || (_templateObject10 = (0, _taggedTemplateLiteral2["default"])(["\n  display: block;\n  margin: 0 auto;\n  position: absolute;\n  text-align: center;\n  width: 110px;\n"])));
@@ -246,7 +223,7 @@ var SpinnerLabel = _styledComponents["default"].p(_templateObject11 || (_templat
 });
 
 var SpinnerProgress = _styledComponents["default"].p(_templateObject12 || (_templateObject12 = (0, _taggedTemplateLiteral2["default"])(["\n  margin: 0;\n  width: 100%;\n  white-space: nowrap;\n  overflow: hidden;\n  text-overflow: ellipsis;\n  display: ", ";\n  font-family: ", ";\n  font-weight: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  color: ", ";\n  text-align: ", ";\n  letter-spacing: ", ";\n"])), function (props) {
-  return props.value !== "" && props.showValue === true && "block" || "none";
+  return props.value && props.showValue === true && "block" || "none";
 }, function (props) {
   return props.mode === "overlay" ? props.theme.overlayProgressValueFontFamily : props.theme.progressValueFontFamily;
 }, function (props) {

package/spinner/Spinner.stories.jsx

@@ -2,66 +2,84 @@ import React from "react";
 import DxcSpinner from "./Spinner";
 import Title from "../../.storybook/components/Title";
 import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
 
 export default {
   title: "Spinner",
   component: DxcSpinner,
 };
 
+const opinionatedTheme = {
+  spinner: {
+    accentColor: "#5f249f",
+    baseColor: "#ffffff",
+    fontColor: "#000000",
+    overlayColor: "#a46ede",
+    overlayFontColor: "#ffffff",
+  },
+};
+
 export const Chromatic = () => (
   <>
     <ExampleContainer>
       <Title title="With label" theme="light" level={4} />
-      <DxcSpinner label="Label" value="50"></DxcSpinner>
+      <DxcSpinner label="Label" value={50}></DxcSpinner>
       <Title title="With value label" theme="light" level={4} />
-      <DxcSpinner value="50" showValue></DxcSpinner>
+      <DxcSpinner value={50} showValue></DxcSpinner>
       <Title title="With label and value label" theme="light" level={4} />
-      <DxcSpinner label="Label" value="50" showValue></DxcSpinner>
+      <DxcSpinner label="Label" value={50} showValue></DxcSpinner>
       <Title title="With 100%" theme="light" level={4} />
-      <DxcSpinner label="Label" value="100" showValue></DxcSpinner>
+      <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>
+      <DxcSpinner mode="large" value={50}></DxcSpinner>
       <Title title="Mode small" theme="light" level={4} />
-      <DxcSpinner mode="small" value="50"></DxcSpinner>
+      <DxcSpinner mode="small" value={50}></DxcSpinner>
       <Title title="Mode small with 100%" theme="light" level={4} />
-      <DxcSpinner mode="small" value="100" showValue></DxcSpinner>
+      <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>
+      <DxcSpinner margin="xxsmall" value={75}></DxcSpinner>
       <Title title="Xsmall margin" theme="light" level={4} />
-      <DxcSpinner margin="xsmall" value="75"></DxcSpinner>
+      <DxcSpinner margin="xsmall" value={75}></DxcSpinner>
       <Title title="Small margin" theme="light" level={4} />
-      <DxcSpinner margin="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="small" value={75}></DxcSpinner>
       <Title title="Medium margin" theme="light" level={4} />
-      <DxcSpinner margin="medium" value="75"></DxcSpinner>
+      <DxcSpinner margin="medium" value={75}></DxcSpinner>
       <Title title="Large margin" theme="light" level={4} />
-      <DxcSpinner margin="large" value="75"></DxcSpinner>
+      <DxcSpinner margin="large" value={75}></DxcSpinner>
       <Title title="Xlarge margin" theme="light" level={4} />
-      <DxcSpinner margin="xlarge" value="75"></DxcSpinner>
+      <DxcSpinner margin="xlarge" value={75}></DxcSpinner>
       <Title title="Xxlarge margin" theme="light" level={4} />
-      <DxcSpinner margin="xxlarge" value="75"></DxcSpinner>
+      <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>
+      <DxcSpinner margin="xxsmall" mode="small" value={75}></DxcSpinner>
       <Title title="Xsmall margin" theme="light" level={4} />
-      <DxcSpinner margin="xsmall" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="xsmall" mode="small" value={75}></DxcSpinner>
       <Title title="Small margin" theme="light" level={4} />
-      <DxcSpinner margin="small" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="small" mode="small" value={75}></DxcSpinner>
       <Title title="Medium margin" theme="light" level={4} />
-      <DxcSpinner margin="medium" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="medium" mode="small" value={75}></DxcSpinner>
       <Title title="Large margin" theme="light" level={4} />
-      <DxcSpinner margin="large" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="large" mode="small" value={75}></DxcSpinner>
       <Title title="Xlarge margin" theme="light" level={4} />
-      <DxcSpinner margin="xlarge" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="xlarge" mode="small" value={75}></DxcSpinner>
       <Title title="Xxlarge margin" theme="light" level={4} />
-      <DxcSpinner margin="xxlarge" mode="small" value="75"></DxcSpinner>
+      <DxcSpinner margin="xxlarge" mode="small" value={75}></DxcSpinner>
+    </ExampleContainer>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="With label and value label" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcSpinner label="Label" value={50} showValue></DxcSpinner>
+      </HalstackProvider>
     </ExampleContainer>
   </>
 );
@@ -69,34 +87,43 @@ export const Chromatic = () => (
 export const SpinnerOverlay = () => (
   <ExampleContainer>
     <Title title="Mode overlay" theme="light" level={4} />
-    <DxcSpinner mode="overlay" value="25"></DxcSpinner>
+    <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>
+    <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>
+    <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>
+    <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>
+    <DxcSpinner mode="overlay" label="Label" value={50} showValue></DxcSpinner>
+  </ExampleContainer>
+);
+
+export const SpinnerOverlayWithValueAndLabelOpinionated = () => (
+  <ExampleContainer>
+    <HalstackProvider theme={opinionatedTheme}>
+      <Title title="Mode overlay" theme="light" level={4} />
+      <DxcSpinner mode="overlay" label="Label" value={50} showValue></DxcSpinner>
+    </HalstackProvider>
   </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.tsx"));
+
+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/switch/Switch.d.ts

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