@dxc-technology/halstack-react 0.0.0-2455fac → 0.0.0-2499c33

package/button/types.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="react" />
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Margin = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
-declare type Props = {
+type SVG = React.ReactNode & React.SVGProps<SVGSVGElement>;
+type Props = {
     /**
      * Text to be placed in the button.
      */
@@ -24,12 +24,16 @@ declare type Props = {
      * Whether the icon should appear after or before the label.
      */
     iconPosition?: "before" | "after";
+    /**
+     * Value for the HTML properties title and aria-label.
+     */
+    title?: string;
     /**
      * 'type' html prop of the button.
      */
     type?: "button" | "reset" | "submit";
     /**
-     * Element or path used as the icon that will be placed next to the label.
+     * Material Symbol name or SVG element as the icon that will be placed next to the label.
      */
     icon?: string | SVG;
     /**

package/card/Card.accessibility.test.js

@@ -0,0 +1,36 @@
+"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 _Card = _interopRequireDefault(require("./Card.tsx"));
+describe("Card component accessibility tests", function () {
+  it("Should not have basic accessibility issues", /*#__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(_Card["default"], {
+            linkHref: "https://www.dxc.com",
+            imageSrc: "https://picsum.photos/id/1022/200/300",
+            imagePosition: "after",
+            imagePadding: "xsmall",
+            margin: "medium",
+            imageBgColor: "yellow",
+            imageCover: true
+          }, "test-card")), 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/card/Card.js

@@ -1,60 +1,44 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof3 = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
-
 var _variables = require("../common/variables");
-
 var _useTheme = _interopRequireDefault(require("../useTheme"));
-
 var _Box = _interopRequireDefault(require("../box/Box"));
-
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
-
-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 || _typeof3(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; }
-
+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" != _typeof3(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 && Object.prototype.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 DxcCard = function DxcCard(_ref) {
   var imageSrc = _ref.imageSrc,
-      _ref$imageBgColor = _ref.imageBgColor,
-      imageBgColor = _ref$imageBgColor === void 0 ? "black" : _ref$imageBgColor,
-      imagePadding = _ref.imagePadding,
-      _ref$imagePosition = _ref.imagePosition,
-      imagePosition = _ref$imagePosition === void 0 ? "before" : _ref$imagePosition,
-      linkHref = _ref.linkHref,
-      onClick = _ref.onClick,
-      _ref$imageCover = _ref.imageCover,
-      imageCover = _ref$imageCover === void 0 ? false : _ref$imageCover,
-      margin = _ref.margin,
-      _ref$tabIndex = _ref.tabIndex,
-      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex,
-      _ref$outlined = _ref.outlined,
-      outlined = _ref$outlined === void 0 ? true : _ref$outlined,
-      children = _ref.children;
+    _ref$imageBgColor = _ref.imageBgColor,
+    imageBgColor = _ref$imageBgColor === void 0 ? "black" : _ref$imageBgColor,
+    imagePadding = _ref.imagePadding,
+    _ref$imagePosition = _ref.imagePosition,
+    imagePosition = _ref$imagePosition === void 0 ? "before" : _ref$imagePosition,
+    linkHref = _ref.linkHref,
+    onClick = _ref.onClick,
+    _ref$imageCover = _ref.imageCover,
+    imageCover = _ref$imageCover === void 0 ? false : _ref$imageCover,
+    margin = _ref.margin,
+    _ref$tabIndex = _ref.tabIndex,
+    tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex,
+    _ref$outlined = _ref.outlined,
+    outlined = _ref$outlined === void 0 ? true : _ref$outlined,
+    children = _ref.children;
   var colorsTheme = (0, _useTheme["default"])();
-
   var _useState = (0, _react.useState)(false),
-      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
-      isHovered = _useState2[0],
-      changeIsHovered = _useState2[1];
-
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+    isHovered = _useState2[0],
+    changeIsHovered = _useState2[1];
   return /*#__PURE__*/_react["default"].createElement(Card, {
     hasAction: onClick || linkHref ? true : false,
     margin: margin,
@@ -83,7 +67,6 @@ var DxcCard = function DxcCard(_ref) {
     src: imageSrc
   })), /*#__PURE__*/_react["default"].createElement(CardContent, null, children)))));
 };
-
 var Card = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  cursor: ", ";\n  outline: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  text-decoration: none;\n  ", "\n"])), function (_ref2) {
   var hasAction = _ref2.hasAction;
   return hasAction && "pointer" || "unset";
@@ -109,7 +92,6 @@ var Card = _styledComponents["default"].div(_templateObject || (_templateObject
   var hasAction = _ref9.hasAction;
   return hasAction && ":focus {\n      outline: #0095ff auto 1px;\n    }";
 });
-
 var CardContainer = _styledComponents["default"].div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  flex-direction: ", ";\n  height: ", ";\n  width: ", ";\n  &:hover {\n    border-color: ", ";\n  }\n"])), function (props) {
   return props.imagePosition === "after" ? "row-reverse" : "row";
 }, function (props) {
@@ -120,7 +102,6 @@ var CardContainer = _styledComponents["default"].div(_templateObject2 || (_templ
   var hasAction = _ref10.hasAction;
   return hasAction ? "" : "unset";
 });
-
 var TagImage = _styledComponents["default"].img(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  height: ", ";\n  width: ", ";\n  object-fit: ", ";\n"])), function (_ref11) {
   var imagePadding = _ref11.imagePadding;
   return !imagePadding ? "100%" : (0, _typeof2["default"])(imagePadding) !== "object" && "calc(100% - ".concat(_variables.spaces[imagePadding], " - ").concat(_variables.spaces[imagePadding], ")");
@@ -131,13 +112,9 @@ var TagImage = _styledComponents["default"].img(_templateObject3 || (_templateOb
   var imageCover = _ref13.imageCover;
   return imageCover ? "cover" : "contain";
 });
-
 var ImageContainer = _styledComponents["default"].div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  justify-content: center;\n  align-items: center;\n  flex-shrink: 0;\n  width: 35%;\n  height: 100%;\n  background-color: ", ";\n"])), function (_ref14) {
   var imageBgColor = _ref14.imageBgColor;
   return imageBgColor;
 });
-
 var CardContent = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  flex-grow: 1;\n  overflow: hidden;\n"])));
-
-var _default = DxcCard;
-exports["default"] = _default;
+var _default = exports["default"] = DxcCard;

package/card/Card.test.js

@@ -1,50 +1,39 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _react = _interopRequireDefault(require("react"));
-
 var _react2 = require("@testing-library/react");
-
 var _Card = _interopRequireDefault(require("./Card.tsx"));
-
 describe("Card component tests", function () {
   test("Card renders with correct content", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], null, "test-card")),
-        getByText = _render.getByText;
-
+      getByText = _render.getByText;
     expect(getByText("test-card")).toBeTruthy();
   });
   test("Card renders with correct href", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
-      linkHref: "/testPage"
-    }, "test-card")),
-        getByRole = _render2.getByRole;
-
+        linkHref: "/testPage"
+      }, "test-card")),
+      getByRole = _render2.getByRole;
     var card = getByRole("link");
     expect(card.getAttribute("href")).toEqual("/testPage");
   });
   test("Card renders with correct image", function () {
     var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
-      imageSrc: "/testImage"
-    }, "test-card")),
-        getByRole = _render3.getByRole;
-
+        imageSrc: "/testImage"
+      }, "test-card")),
+      getByRole = _render3.getByRole;
     var card = getByRole("img");
     expect(card.getAttribute("src")).toEqual("/testImage");
   });
   test("OnClick function is called", function () {
     var onClick = jest.fn();
-
     var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Card["default"], {
-      onClick: onClick
-    }, "test-card")),
-        getByText = _render4.getByText;
-
+        onClick: onClick
+      }, "test-card")),
+      getByText = _render4.getByText;
     var card = getByText("test-card");
-
     _react2.fireEvent.click(card);
-
     expect(onClick).toHaveBeenCalled();
   });
 });

package/card/types.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
-declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-declare type Size = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Size = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type Props = {
+type Props = {
     /**
      * URL of the image that will be placed in the card component.
      * In case of omission, the image container will not appear and
@@ -47,7 +47,7 @@ declare type Props = {
      */
     margin?: Space | Size;
     /**
-     * Value of the tabindex given when there is an href.
+     * Value of the tabindex attribute applied when the component is clickable.
      */
     tabIndex?: number;
     /**
@@ -55,7 +55,7 @@ declare type Props = {
      */
     outlined?: boolean;
     /**
-     * Custom content that will be placed in the card component.
+     * Custom content that will be placed inside the component.
      */
     children?: React.ReactNode;
 };

package/checkbox/Checkbox.accessibility.test.js

@@ -0,0 +1,87 @@
+"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 _Checkbox = _interopRequireDefault(require("./Checkbox.tsx"));
+describe("Checkbox component accessibility tests", function () {
+  it("Should not have basic accessibility issues", /*#__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(_Checkbox["default"], {
+            label: "Checkbox",
+            labelPosition: "after",
+            name: "name",
+            size: "fitContent",
+            value: "checkboxValue",
+            margin: "small",
+            defaultChecked: true,
+            optional: true
+          })), 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);
+  })));
+  it("Should not have basic accessibility issues for read-only mode", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+    var _render2, container, results;
+    return _regenerator["default"].wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+            label: "Checkbox",
+            labelPosition: "after",
+            name: "name",
+            size: "fitContent",
+            value: "checkboxValue",
+            margin: "small",
+            readOnly: true
+          })), container = _render2.container;
+          _context2.next = 3;
+          return (0, _jestAxe.axe)(container);
+        case 3:
+          results = _context2.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+  it("Should not have basic accessibility issues for disabled mode", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
+    var _render3, container, results;
+    return _regenerator["default"].wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+            label: "Checkbox",
+            labelPosition: "after",
+            name: "name",
+            size: "fitContent",
+            value: "checkboxValue",
+            margin: "small",
+            disabled: true
+          })), container = _render3.container;
+          _context3.next = 3;
+          return (0, _jestAxe.axe)(container);
+        case 3:
+          results = _context3.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  })));
+});