@dxc-technology/halstack-react 0.0.0-28a98e5 → 0.0.0-290c489

package/password-input/types.d.ts

@@ -0,0 +1,110 @@
+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 above the password.
+     */
+    label?: string;
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * Value of the input element. If undefined, the component will be uncontrolled and the value will be managed internally by the component.
+     */
+    value?: string;
+    /**
+     * Helper text to be placed above the password.
+     */
+    helperText?: string;
+    /**
+     * If true, the password input will have an action to clear the entered value.
+     */
+    clearable?: boolean;
+    /**
+     * This function will be called when the user types within the input
+     * element of the component. An object including the current value and
+     * the error (if the value entered is not valid) will be passed to this
+     * function. If there is no error, error will not be defined.
+     * */
+    onChange?: (val: {
+        value: string;
+        error?: string;
+    }) => void;
+    /**
+     * This function will be called when the input element loses the focus.
+     * An object including the input value and the error (if the value entered is
+     * not valid) will be passed to this function. If there is no error, error will not be defined.
+     */
+    onBlur?: (val: {
+        value: string;
+        error?: string;
+    }) => void;
+    /**
+     * If it is a defined value and also a truthy string, the component will
+     * change its appearance, showing the error below the password input
+     * component. If the defined value is an empty string, it will reserve a
+     * space below the component for a future error, but it would not change
+     * its look. In case of being undefined or null, both the appearance and
+     * the space for the error message would not be modified.
+     */
+    error?: string;
+    /**
+     * Regular expression that defines the valid format allowed by the
+     * password input. This will be checked both when the input element loses the
+     * focus and while typing within it. If the string entered does not match
+     * the pattern, the onBlur and onChange functions will be called with the
+     * current value and an internal error informing that this value does not
+     * match the pattern. If the pattern is met, the error parameter of both
+     * events will not be defined.
+     */
+    pattern?: string;
+    /**
+     * Specifies the minimun length allowed by the password input.
+     * This will be checked both when the input element loses the
+     * focus and while typing within it. If the string entered does not
+     * comply the minimum length, the onBlur and onChange functions will be called
+     * with the current value and an internal error informing that the value
+     * length does not comply the specified range. If a valid length is
+     * reached, the error parameter of both events will not be defined.
+     */
+    minLength?: number;
+    /**
+     * Specifies the maximum length allowed by the password input.
+     * This will be checked both when the input element loses the
+     * focus and while typing within it. If the string entered does not
+     * comply the maximum length, the onBlur and onChange functions will be called
+     * with the current value and an internal error informing that the value
+     * length does not comply the specified range. If a valid length is
+     * reached, the error parameter of both events will not be defined.
+     */
+    maxLength?: number;
+    /**
+     * HTML autocomplete attribute. Lets the user specify if any permission the user agent has to provide automated assistance in filling out the input value.
+     * Its value must be one of all the possible values of the HTML autocomplete attribute: 'on', 'off', 'email', 'username', 'new-password', ...
+     */
+    autocomplete?: string;
+    /**
+     * 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";
+    /**
+     * Value of the tabindex attribute.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/password-input/types.js

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

package/progress-bar/ProgressBar.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import ProgressBarPropsType from "./types";
+declare const DxcProgressBar: ({ label, helperText, overlay, value, showValue, margin, }: ProgressBarPropsType) => JSX.Element;
+export default DxcProgressBar;

package/progress-bar/ProgressBar.js

@@ -9,8 +9,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
@@ -21,13 +19,11 @@ var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
 var _LinearProgress = _interopRequireDefault(require("@material-ui/core/LinearProgress"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _variables = require("../common/variables.js");
 
-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;
 
@@ -41,7 +37,7 @@ var DxcProgressBar = function DxcProgressBar(_ref) {
       _ref$helperText = _ref.helperText,
       helperText = _ref$helperText === void 0 ? "" : _ref$helperText,
       _ref$overlay = _ref.overlay,
-      overlay = _ref$overlay === void 0 ? true : _ref$overlay,
+      overlay = _ref$overlay === void 0 ? false : _ref$overlay,
       value = _ref.value,
       _ref$showValue = _ref.showValue,
       showValue = _ref$showValue === void 0 ? false : _ref$showValue,
@@ -63,10 +59,9 @@ var DxcProgressBar = function DxcProgressBar(_ref) {
     overlay: overlay,
     showValue: showValue,
     backgroundType: backgroundType
-  }, value === "" ? 0 : value >= 0 && value <= 100 ? value : value < 0 ? 0 : 100, " %")), /*#__PURE__*/_react["default"].createElement(_LinearProgress["default"], {
+  }, value === null || value === undefined ? 0 : value >= 0 && value <= 100 ? value : value < 0 ? 0 : 100, " %")), /*#__PURE__*/_react["default"].createElement(_LinearProgress["default"], {
     variant: showValue ? "determinate" : "indeterminate",
-    value: value === "" ? 0 : value >= 0 && value <= 100 ? value : value < 0 ? 0 : 100,
-    helperText: helperText
+    value: value === null || value === undefined ? 0 : value >= 0 && value <= 100 ? value : value < 0 ? 0 : 100
   }), helperText && /*#__PURE__*/_react["default"].createElement(HelperText, {
     overlay: overlay,
     backgroundType: backgroundType
@@ -162,7 +157,7 @@ var ProgressBarProgress = _styledComponents["default"].div(_templateObject5 || (
 var HelperText = _styledComponents["default"].span(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: 1.5em;\n"])), function (props) {
   return props.backgroundType === "dark" ? props.theme.helperTextFontColorOnDark : props.overlay === true ? "#FFFFFF" : props.theme.helperTextFontColor;
 }, function (props) {
-  return props.theme.fontFamily;
+  return props.theme.helperTextFontFamily;
 }, function (props) {
   return props.theme.helperTextFontSize;
 }, function (props) {
@@ -171,18 +166,5 @@ var HelperText = _styledComponents["default"].span(_templateObject6 || (_templat
   return props.theme.helperTextFontWeight;
 });
 
-DxcProgressBar.propTypes = {
-  label: _propTypes["default"].string,
-  helperText: _propTypes["default"].string,
-  overlay: _propTypes["default"].bool,
-  value: _propTypes["default"].number,
-  showValue: _propTypes["default"].bool,
-  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 _default = DxcProgressBar;
 exports["default"] = _default;

package/progress-bar/ProgressBar.stories.jsx

@@ -0,0 +1,58 @@
+import React from "react";
+import DxcProgressBar from "./ProgressBar";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+
+export default {
+  title: "ProgressBar",
+  component: DxcProgressBar,
+};
+
+export const Chromatic = () => (
+  <>
+    <ExampleContainer>
+      <Title title="Without labels" theme="light" level={4} />
+      <DxcProgressBar value={50} showValue />
+      <Title title="With helperText" theme="light" level={4} />
+      <DxcProgressBar helperText="Helper text" value={50} showValue />
+      <Title title="Without default value" theme="light" level={4} />
+      <DxcProgressBar label="Loading..." showValue />
+    </ExampleContainer>
+    <Title title="Margins" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Xxsmall margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xxsmall" margin="xxsmall" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xsmall margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xsmall" margin="xsmall" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Small margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin small" margin="small" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Medium margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin medium" margin="medium" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Large margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin large" margin="large" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Xlarge margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xlarge" margin="xlarge" value={50} showValue />
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="XxLarge margin" theme="light" level={4} />
+      <DxcProgressBar label="Margin xxlarge" margin="xxlarge" value={50} showValue />
+    </ExampleContainer>
+  </>
+);
+
+export const ProgressBarOverlay = () => (
+  <ExampleContainer>
+    <Title title="Overlay" theme="dark" level={4} />
+    <DxcProgressBar label="Overlay" helperText="Helper text" overlay={true} showValue value={50} />
+  </ExampleContainer>
+);

package/progress-bar/ProgressBar.test.js

@@ -0,0 +1,65 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _ProgressBar = _interopRequireDefault(require("./ProgressBar"));
+
+describe("ProgressBar component tests", function () {
+  test("ProgressBar renders with label", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      label: "test-label"
+    })),
+        getByText = _render.getByText;
+
+    expect(getByText("test-label")).toBeTruthy();
+  });
+  test("Overlay progressBar renders with label", function () {
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      label: "test-label",
+      overlay: true
+    })),
+        getByText = _render2.getByText;
+
+    expect(getByText("test-label")).toBeTruthy();
+  });
+  test("ProgressBar renders with default value", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      showValue: true
+    })),
+        getByText = _render3.getByText;
+
+    expect(getByText("0 %")).toBeTruthy();
+  });
+  test("Overlay progressBar renders with default value", function () {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      showValue: true,
+      overlay: true
+    })),
+        getByText = _render4.getByText;
+
+    expect(getByText("0 %")).toBeTruthy();
+  });
+  test("ProgressBar renders with value", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      showValue: true,
+      value: 25
+    })),
+        getByText = _render5.getByText;
+
+    expect(getByText("25 %")).toBeTruthy();
+  });
+  test("Overlay progressBar renders with value", function () {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+      showValue: true,
+      value: 25,
+      overlay: true
+    })),
+        getByText = _render6.getByText;
+
+    expect(getByText("25 %")).toBeTruthy();
+  });
+});

package/progress-bar/types.d.ts

@@ -0,0 +1,37 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Size = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Text to be placed above the progress bar.
+     */
+    label?: string;
+    /**
+     * Helper text to be placed under the progress bar.
+     */
+    helperText?: string;
+    /**
+     * If true, the progress bar will be displayed as a modal.
+     */
+    overlay?: boolean;
+    /**
+     * 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 above the progress bar.
+     */
+    showValue?: boolean;
+    /**
+     * Size of the margin to be applied to the component. You can pass
+     * an object with 'top', 'bottom', 'left' and 'right' properties
+     * in order to specify different margin sizes.
+     */
+    margin?: Space | Size;
+};
+export default Props;

package/progress-bar/types.js

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

package/quick-nav/QuickNav.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import QuickNavTypes from "./types";
+declare const DxcQuickNav: ({ title, links }: QuickNavTypes) => JSX.Element;
+export default DxcQuickNav;

package/quick-nav/QuickNav.js

@@ -0,0 +1,118 @@
+"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 _slugify = _interopRequireDefault(require("slugify"));
+
+var _useTheme = _interopRequireDefault(require("../useTheme"));
+
+var _Heading = _interopRequireDefault(require("../heading/Heading"));
+
+var _Flex = _interopRequireDefault(require("../flex/Flex"));
+
+var _Inset = _interopRequireDefault(require("../inset/Inset"));
+
+var _Typography = _interopRequireDefault(require("../typography/Typography"));
+
+var _useTranslatedLabels = _interopRequireDefault(require("../useTranslatedLabels"));
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+
+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 DxcQuickNav = function DxcQuickNav(_ref) {
+  var title = _ref.title,
+      links = _ref.links;
+  var translatedLabels = (0, _useTranslatedLabels["default"])();
+  var colorsTheme = (0, _useTheme["default"])();
+  return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
+    theme: colorsTheme.quickNav
+  }, /*#__PURE__*/_react["default"].createElement(QuickNavContainer, null, /*#__PURE__*/_react["default"].createElement(_Flex["default"], {
+    direction: "column",
+    gap: "0.5rem"
+  }, /*#__PURE__*/_react["default"].createElement(_Heading["default"], {
+    level: 4,
+    text: title || translatedLabels.quickNav.contentTitle
+  }), /*#__PURE__*/_react["default"].createElement(ListColumn, null, /*#__PURE__*/_react["default"].createElement(_Flex["default"], {
+    direction: "column",
+    gap: "0.5rem"
+  }, links.map(function (link) {
+    var _link$links;
+
+    return /*#__PURE__*/_react["default"].createElement(ListRow, {
+      key: link.label
+    }, /*#__PURE__*/_react["default"].createElement(_Inset["default"], {
+      space: "0.25rem"
+    }, /*#__PURE__*/_react["default"].createElement(_Typography["default"], null, /*#__PURE__*/_react["default"].createElement(Link, {
+      href: "#".concat((0, _slugify["default"])(link === null || link === void 0 ? void 0 : link.label, {
+        lower: true
+      }))
+    }, link === null || link === void 0 ? void 0 : link.label), (_link$links = link.links) === null || _link$links === void 0 ? void 0 : _link$links.map(function (sublink) {
+      return /*#__PURE__*/_react["default"].createElement(ListRow, {
+        key: sublink.label
+      }, /*#__PURE__*/_react["default"].createElement(_Inset["default"], {
+        horizontal: "0.5rem"
+      }, /*#__PURE__*/_react["default"].createElement(_Typography["default"], null, /*#__PURE__*/_react["default"].createElement(Link, {
+        href: "#".concat((0, _slugify["default"])(sublink === null || sublink === void 0 ? void 0 : sublink.label, {
+          lower: true
+        }))
+      }, sublink === null || sublink === void 0 ? void 0 : sublink.label))));
+    }))));
+  }))))));
+};
+
+var QuickNavContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  padding-top: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  padding-right: ", ";\n  border-left: 2px solid ", ";\n"])), function (props) {
+  return props.theme.paddingTop;
+}, function (props) {
+  return props.theme.paddingBottom;
+}, function (props) {
+  return props.theme.paddingLeft;
+}, function (props) {
+  return props.theme.paddingRight;
+}, function (props) {
+  return props.theme.dividerBorderColor;
+});
+
+var ListColumn = _styledComponents["default"].ul(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  list-style-type: none;\n  margin: 0;\n  padding: 0;\n  width: 100%;\n"])));
+
+var ListRow = _styledComponents["default"].li(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  width: 100%;\n"])));
+
+var Link = _styledComponents["default"].a(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  text-decoration: none;\n  font-size: ", ";\n  font-family: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  color: ", ";\n  display: block;\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  overflow: hidden;\n  width: fit-content;\n  max-width: 100%;\n\n  &:hover {\n    color: ", ";\n  }\n  &:focus {\n    outline-color: ", ";\n    outline-style: ", ";\n    outline-width: ", ";\n    border-radius: ", ";\n  }\n"])), function (props) {
+  return props.theme.fontSize;
+}, function (props) {
+  return props.theme.fontFamily;
+}, function (props) {
+  return props.theme.fontStyle;
+}, function (props) {
+  return props.theme.fontWeight;
+}, function (props) {
+  return props.theme.fontColor;
+}, function (props) {
+  return props.theme.hoverFontColor;
+}, function (props) {
+  return props.theme.focusBorderColor;
+}, function (props) {
+  return props.theme.focusBorderStyle;
+}, function (props) {
+  return props.theme.focusBorderThickness;
+}, function (props) {
+  return props.theme.focusBorderRadius;
+});
+
+var _default = DxcQuickNav;
+exports["default"] = _default;