@dxc-technology/halstack-react 0.0.0-0b14645 → 0.0.0-0b2a880

package/progress-bar/ProgressBar.stories.tsx

@@ -0,0 +1,93 @@
+import React from "react";
+import DxcProgressBar from "./ProgressBar";
+import Title from "../../.storybook/components/Title";
+import ExampleContainer from "../../.storybook/components/ExampleContainer";
+import { HalstackProvider } from "../HalstackContext";
+
+export default {
+  title: "Progress Bar",
+  component: DxcProgressBar,
+};
+
+const opinionatedTheme = {
+  progressBar: {
+    accentColor: "#5f249f",
+    baseColor: "#e6e6e6",
+    fontColor: "#000000",
+    overlayColor: "#000000b3",
+    overlayFontColor: "#ffffff",
+  },
+};
+
+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={24} showValue />
+      <Title title="Without default value" theme="light" level={4} />
+      <DxcProgressBar label="Loading..." showValue />
+      <Title title="With full value" theme="light" level={4} />
+      <DxcProgressBar label="Loading..." value={100} 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>
+    <Title title="Opinionated theme" theme="light" level={2} />
+    <ExampleContainer>
+      <Title title="Label and helper text" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcProgressBar label="Loading..." helperText="Helper text" value={24} showValue />
+      </HalstackProvider>
+    </ExampleContainer>
+    <ExampleContainer>
+      <Title title="Without default value" theme="light" level={4} />
+      <HalstackProvider theme={opinionatedTheme}>
+        <DxcProgressBar label="Loading..." helperText="Helper text" showValue />
+      </HalstackProvider>
+    </ExampleContainer>
+  </>
+);
+
+export const ProgressBarOverlay = () => (
+  <ExampleContainer>
+    <Title title="Overlay" theme="dark" level={4} />
+    <DxcProgressBar label="Overlay" helperText="Helper text" overlay showValue value={50} />
+  </ExampleContainer>
+);
+
+export const ProgressBarOverlayOpinionated = () => (
+  <ExampleContainer>
+    <Title title="Overlay" theme="dark" level={4} />
+    <HalstackProvider theme={opinionatedTheme}>
+      <DxcProgressBar label="Overlay" helperText="Helper text" overlay showValue value={50} />
+    </HalstackProvider>
+  </ExampleContainer>
+);

package/progress-bar/ProgressBar.test.js

@@ -0,0 +1,93 @@
+"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.tsx"));
+describe("ProgressBar component tests", function () {
+  test("ProgressBar renders with label and helperText", function () {
+    var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        label: "test-label",
+        helperText: "helper-text"
+      })),
+      getByText = _render.getByText;
+    expect(getByText("test-label")).toBeTruthy();
+    expect(getByText("helper-text")).toBeTruthy();
+  });
+  test("ProgressBar renders with default value", function () {
+    var value = 0;
+    var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        showValue: true
+      })),
+      getByText = _render2.getByText,
+      getByRole = _render2.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(getByText("0 %")).toBeTruthy();
+    expect(progressBar.getAttribute("aria-valuenow")).toEqual(value.toString());
+  });
+  test("ProgressBar renders with value", function () {
+    var value = 25;
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        showValue: true,
+        value: value
+      })),
+      getByText = _render3.getByText,
+      getByRole = _render3.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(getByText("25 %")).toBeTruthy();
+    expect(progressBar.getAttribute("aria-valuenow")).toEqual(value.toString());
+  });
+  test("ProgressBar renders with negative value", function () {
+    var value = 0;
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        showValue: true,
+        value: -20
+      })),
+      getByText = _render4.getByText,
+      getByRole = _render4.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(getByText("0 %")).toBeTruthy();
+    expect(progressBar.getAttribute("aria-valuenow")).toEqual(value.toString());
+  });
+  test("ProgressBar renders as indeterminate", function () {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], null)),
+      getByRole = _render5.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(progressBar.getAttribute("aria-valuenow")).toBe(null);
+  });
+  test("Overlay progressBar renders with label and helperText", function () {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        label: "test-label",
+        helperText: "helper-text",
+        overlay: true
+      })),
+      getByText = _render6.getByText;
+    expect(getByText("test-label")).toBeTruthy();
+    expect(getByText("helper-text")).toBeTruthy();
+  });
+  test("Overlay progressBar renders with default value", function () {
+    var value = 0;
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        showValue: true,
+        overlay: true
+      })),
+      getByText = _render7.getByText,
+      getByRole = _render7.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(getByText("0 %")).toBeTruthy();
+    expect(progressBar.getAttribute("aria-valuenow")).toEqual(value.toString());
+  });
+  test("Overlay progressBar renders with value", function () {
+    var value = 25;
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_ProgressBar["default"], {
+        showValue: true,
+        value: value,
+        overlay: true
+      })),
+      getByText = _render8.getByText,
+      getByRole = _render8.getByRole;
+    var progressBar = getByRole("progressbar");
+    expect(getByText("25 %")).toBeTruthy();
+    expect(progressBar.getAttribute("aria-valuenow")).toEqual(value.toString());
+  });
+});

package/progress-bar/types.d.ts

@@ -0,0 +1,37 @@
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Size = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+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.accessibility.test.js

@@ -0,0 +1,57 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _jestAxe = require("jest-axe");
+var _QuickNav = _interopRequireDefault(require("./QuickNav"));
+var links = [{
+  label: "Overview",
+  links: [{
+    label: "Introduction"
+  }]
+}, {
+  label: "Components",
+  links: [{
+    label: "Introduction"
+  }, {
+    label: "Accordion"
+  }]
+}, {
+  label: "Principles very very very very very very very very long",
+  links: [{
+    label: "Color very very very very very very very very long"
+  }, {
+    label: "Spacingveryveryveryveryveryveryveryverylong"
+  }, {
+    label: "Typography"
+  }]
+}, {
+  label: "Componentsveryveryveryveryveryveryveryverylong",
+  links: [{
+    label: "Accordion"
+  }]
+}];
+describe("Quick Nav component accessibility tests", function () {
+  it("Should not have basic accessibility issues for icon mode", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var _render, container, results;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_QuickNav["default"], {
+            links: links
+          })), container = _render.container;
+          _context.next = 3;
+          return (0, _jestAxe.axe)(container);
+        case 3:
+          results = _context.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+});

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,94 @@
+"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(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
+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, links.map(function (link) {
+    var _link$links;
+    return /*#__PURE__*/_react["default"].createElement("li", {
+      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), /*#__PURE__*/_react["default"].createElement(ListSecondColumn, null, (_link$links = link.links) === null || _link$links === void 0 ? void 0 : _link$links.map(function (sublink) {
+      return /*#__PURE__*/_react["default"].createElement("li", {
+        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"])(link === null || link === void 0 ? void 0 : link.label, {
+          lower: true
+        }), "-").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  display: flex;\n  flex-direction: column;\n  gap: 0.5rem;\n  margin: 0;\n  padding: 0;\n  list-style-type: none;\n"])));
+var ListSecondColumn = _styledComponents["default"].ul(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-direction: column;\n  margin: 0;\n  padding: 0;\n  list-style-type: none;\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 = exports["default"] = DxcQuickNav;