@dxc-technology/halstack-react 0.0.0-b41d935 → 0.0.0-b4aec06

package/checkbox/Checkbox.test.js

@@ -1,49 +1,110 @@
 "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 _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
-
-var _Checkbox = _interopRequireDefault(require("./Checkbox"));
-
+var _Checkbox = _interopRequireDefault(require("./Checkbox.tsx"));
 describe("Checkbox component tests", function () {
   test("Checkbox renders with correct aria-labelledby and aria-required", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Checkbox"
-    })),
-        getByText = _render.getByText,
-        getByRole = _render.getByRole;
-
+        label: "Checkbox"
+      })),
+      getByText = _render.getByText,
+      getByRole = _render.getByRole;
     var labelId = getByText("Checkbox").getAttribute("id");
     expect(getByRole("checkbox").getAttribute("aria-labelledby")).toBe(labelId);
     expect(getByRole("checkbox").getAttribute("aria-required")).toBe("true");
+    expect(getByRole("checkbox").getAttribute("aria-readonly")).toBe("false");
+    expect(getByRole("checkbox").getAttribute("aria-disabled")).toBe("false");
   });
   test("Optional checkbox renders with correct aria-required", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Checkbox",
-      optional: true
-    })),
-        getByRole = _render2.getByRole;
-
+        label: "Checkbox",
+        optional: true
+      })),
+      getByRole = _render2.getByRole;
     expect(getByRole("checkbox").getAttribute("aria-required")).toBe("false");
   });
-  test("Calls correct function on click", function () {
+  test("Calls correct function onChange", function () {
     var onChange = jest.fn();
-
     var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Checkbox",
-      onChange: onChange
-    })),
-        getByText = _render3.getByText;
-
+        label: "Checkbox",
+        onChange: onChange
+      })),
+      getByText = _render3.getByText;
     _react2.fireEvent.click(getByText("Checkbox"));
-
     expect(onChange).toHaveBeenCalled();
   });
+  test("Read-only checkbox does not trigger onChange function", function () {
+    var onChange = jest.fn();
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        readOnly: true
+      })),
+      getByRole = _render4.getByRole;
+    var checkbox = getByRole("checkbox");
+    expect(checkbox.getAttribute("aria-readonly")).toBe("true");
+    _react2.fireEvent.click(checkbox);
+    expect(onChange).not.toHaveBeenCalled();
+  });
+  test("Read-only checkbox sends its value on submit", /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var handlerOnSubmit, _render5, getByText, submit;
+    return _regenerator["default"].wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          handlerOnSubmit = jest.fn(function (e) {
+            e.preventDefault();
+            var formData = new FormData(e.target);
+            var formProps = Object.fromEntries(formData);
+            expect(formProps).toStrictEqual({
+              data: "checked"
+            });
+          });
+          _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement("form", {
+            onSubmit: handlerOnSubmit
+          }, /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+            label: "Checkbox",
+            name: "data",
+            value: "checked",
+            readOnly: true,
+            defaultChecked: true
+          }), /*#__PURE__*/_react["default"].createElement("button", {
+            type: "submit"
+          }, "Submit"))), getByText = _render5.getByText;
+          submit = getByText("Submit");
+          _context.next = 5;
+          return _userEvent["default"].click(submit);
+        case 5:
+          expect(handlerOnSubmit).toHaveBeenCalled();
+        case 6:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  test("Read-only checkbox doesn't change its value with Space key", function () {
+    var onChange = jest.fn();
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        readOnly: true
+      })),
+      getByRole = _render6.getByRole;
+    var checkbox = getByRole("checkbox");
+    _userEvent["default"].tab();
+    expect(document.activeElement === checkbox).toBeTruthy();
+    _react2.fireEvent.keyDown(checkbox, {
+      key: " ",
+      code: "Space",
+      keyCode: 32,
+      charCode: 32
+    });
+    expect(onChange).not.toHaveBeenCalled();
+  });
   test("Uncontrolled checkbox", function () {
     var onChange = jest.fn();
     var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
@@ -56,9 +117,7 @@ describe("Checkbox component tests", function () {
     var submitInput = component.container.querySelector("input[name=\"test\"]");
     expect(input.getAttribute("aria-checked")).toBe("false");
     expect(submitInput.checked).toBe(false);
-
     _react2.fireEvent.click(visibleCheckbox);
-
     expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith(true);
     expect(input.getAttribute("aria-checked")).toBe("true");
@@ -75,24 +134,21 @@ describe("Checkbox component tests", function () {
     var input = component.getByRole("checkbox");
     var visibleCheckbox = component.getByText("Checkbox");
     var submitInput = component.container.querySelector("input[name=\"test\"]");
-
     _react2.fireEvent.click(visibleCheckbox);
-
     expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith(true);
     expect(input.getAttribute("aria-checked")).toBe("false");
     expect(submitInput.checked).toBe(false);
   });
   test("Renders with correct initial value and initial state when it is uncontrolled", function () {
-    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Default label",
-      defaultChecked: true,
-      value: "test-defaultChecked",
-      name: "test"
-    })),
-        getByRole = _render4.getByRole,
-        container = _render4.container;
-
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Default label",
+        defaultChecked: true,
+        value: "test-defaultChecked",
+        name: "test"
+      })),
+      getByRole = _render7.getByRole,
+      container = _render7.container;
     var checkbox = getByRole("checkbox");
     var submitInput = container.querySelector("input[name=\"test\"]");
     expect(submitInput.value).toBe("test-defaultChecked");
@@ -101,55 +157,43 @@ describe("Checkbox component tests", function () {
   });
   test("Test disable keyboard and mouse interactions", function () {
     var onChange = jest.fn();
-
-    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Checkbox",
-      onChange: onChange,
-      disabled: true,
-      name: "test"
-    })),
-        getByRole = _render5.getByRole,
-        getByText = _render5.getByText,
-        container = _render5.container;
-
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        onChange: onChange,
+        disabled: true,
+        name: "test"
+      })),
+      getByRole = _render8.getByRole,
+      getByText = _render8.getByText,
+      container = _render8.container;
     var input = getByRole("checkbox");
     var visibleCheckbox = getByText("Checkbox");
     var submitInput = container.querySelector("input[name=\"test\"]");
-
     _react2.fireEvent.click(visibleCheckbox);
-
     expect(onChange).toHaveBeenCalledTimes(0);
     expect(input.getAttribute("aria-checked")).toBe("false");
     expect(input.getAttribute("aria-disabled")).toBe("true");
     expect(submitInput.checked).toBe(false);
-
     _userEvent["default"].tab();
-
     expect(document.activeElement === input).toBeFalsy();
   });
   test("Test keyboard interactions", function () {
     var onChange = jest.fn();
-
-    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Checkbox",
-      name: "test",
-      onChange: onChange
-    })),
-        getByRole = _render6.getByRole;
-
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Checkbox",
+        name: "test",
+        onChange: onChange
+      })),
+      getByRole = _render9.getByRole;
     var checkbox = getByRole("checkbox");
-
     _userEvent["default"].tab();
-
     expect(document.activeElement === checkbox).toBeTruthy();
-
     _react2.fireEvent.keyDown(checkbox, {
       key: " ",
       code: "Space",
       keyCode: 32,
       charCode: 32
     });
-
     expect(onChange).toHaveBeenCalledWith(true);
   });
 });

package/checkbox/types.d.ts

@@ -1,11 +1,11 @@
-export declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
-export declare type Margin = {
+type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+type Margin = {
     top?: Space;
     bottom?: Space;
     left?: Space;
     right?: Space;
 };
-declare type Props = {
+type Props = {
     /**
      * Initial state of the checkbox, only when it is uncontrolled.
      */
@@ -40,6 +40,10 @@ declare type Props = {
      * If true, the component will display '(Optional)' next to the label.
      */
     optional?: boolean;
+    /**
+     * If true, the component will not be mutable, meaning the user can not edit the control.
+     */
+    readOnly?: boolean;
     /**
      * This function will be called when the user clicks the checkbox.
      * The new value will be passed as a parameter.
@@ -61,4 +65,8 @@ declare type Props = {
      */
     tabIndex?: number;
 };
+/**
+ * Reference to the component.
+ */
+export type RefType = HTMLDivElement;
 export default Props;

package/chip/Chip.js

@@ -1,94 +1,68 @@
 "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 _react = _interopRequireDefault(require("react"));
-
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
-
-var _variables = require("../common/variables.js");
-
-var _utils = require("../common/utils.js");
-
+var _variables = require("../common/variables");
+var _utils = require("../common/utils");
 var _useTheme = _interopRequireDefault(require("../useTheme"));
-
-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; }
-
+var _templateObject, _templateObject2, _templateObject3;
+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 DxcChip = function DxcChip(_ref) {
   var label = _ref.label,
-      suffixIcon = _ref.suffixIcon,
-      prefixIcon = _ref.prefixIcon,
-      onClickSuffix = _ref.onClickSuffix,
-      onClickPrefix = _ref.onClickPrefix,
-      disabled = _ref.disabled,
-      margin = _ref.margin,
-      _ref$tabIndex = _ref.tabIndex,
-      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+    suffixIcon = _ref.suffixIcon,
+    prefixIcon = _ref.prefixIcon,
+    onClickSuffix = _ref.onClickSuffix,
+    onClickPrefix = _ref.onClickPrefix,
+    disabled = _ref.disabled,
+    margin = _ref.margin,
+    _ref$tabIndex = _ref.tabIndex,
+    tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
   var colorsTheme = (0, _useTheme["default"])();
   return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
     theme: colorsTheme.chip
-  }, /*#__PURE__*/_react["default"].createElement(StyledDxcChip, {
+  }, /*#__PURE__*/_react["default"].createElement(Chip, {
     disabled: disabled,
     margin: margin
   }, prefixIcon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    role: typeof onClickPrefix === "function" ? "button" : undefined,
     disabled: disabled,
-    prefixIcon: true,
-    label: label,
-    mode: "prefix",
+    interactuable: typeof onClickPrefix === "function" && !disabled,
     tabIndex: typeof onClickPrefix === "function" && !disabled ? tabIndex : -1,
     onClick: function onClick() {
       return onClickPrefix && !disabled && onClickPrefix();
-    },
-    interactuable: typeof onClickPrefix === "function" && !disabled
-  }, typeof prefixIcon === "string" ? /*#__PURE__*/_react["default"].createElement(PrefixIconContainer, {
+    }
+  }, typeof prefixIcon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
     src: prefixIcon
-  }) : prefixIcon), label && /*#__PURE__*/_react["default"].createElement(ChipTextContainer, {
+  }) : prefixIcon), label && /*#__PURE__*/_react["default"].createElement(LabelContainer, {
     disabled: disabled
   }, label), suffixIcon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    role: typeof onClickSuffix === "function" ? "button" : undefined,
     disabled: disabled,
-    suffixIcon: true,
-    mode: "suffix",
-    label: label,
+    interactuable: typeof onClickSuffix === "function" && !disabled,
     tabIndex: typeof onClickSuffix === "function" && !disabled ? tabIndex : -1,
     onClick: function onClick() {
-      return onClickSuffix && !disabled && onClickSuffix();
-    },
-    interactuable: typeof onClickSuffix === "function" && !disabled
-  }, typeof suffixIcon === "string" ? /*#__PURE__*/_react["default"].createElement(SuffixIconContainer, {
+      return !disabled && (onClickSuffix === null || onClickSuffix === void 0 ? void 0 : onClickSuffix());
+    }
+  }, typeof suffixIcon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
     src: suffixIcon
   }) : suffixIcon)));
 };
-
-var getCursor = function getCursor(interactuable, disabled) {
-  if (disabled) {
-    return "cursor:not-allowed;";
-  }
-
-  if (interactuable) {
-    return "cursor:pointer;";
-  }
-
-  return "cursor:default; outline:none;";
+var calculateWidth = function calculateWidth(margin) {
+  return "calc(100% - ".concat((0, _utils.getMargin)(margin, "left"), " - ").concat((0, _utils.getMargin)(margin, "right"), ")");
 };
-
-var StyledDxcChip = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  align-items: center;\n  min-height: 40px;\n  max-width: ", ";\n  background-color: ", ";\n  border-radius: ", ";\n  border-width: ", ";\n  border-style: ", ";\n  border-color: ", ";\n  padding-top: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  padding-right: ", ";\n\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  cursor: ", ";\n"])), function (_ref2) {
-  var margin = _ref2.margin;
-  return "calc(100% - 40px - ".concat((0, _utils.getMargin)(margin, "left"), " - ").concat((0, _utils.getMargin)(margin, "right"), ")");
+var Chip = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  box-sizing: border-box;\n  display: inline-flex;\n  align-items: center;\n  gap: ", ";\n  min-height: 40px;\n  max-width: ", ";\n  background-color: ", ";\n  border-radius: ", ";\n  border-width: ", ";\n  border-style: ", ";\n  border-color: ", ";\n\n  padding-top: ", ";\n  padding-bottom: ", ";\n  padding-left: ", ";\n  padding-right: ", ";\n  margin: ", ";\n  margin-top: ", ";\n  margin-right: ", ";\n  margin-bottom: ", ";\n  margin-left: ", ";\n  cursor: ", ";\n"])), function (props) {
+  return props.theme.iconSpacing;
+}, function (props) {
+  return calculateWidth(props.margin);
 }, function (props) {
   return props.disabled && props.theme.disabledBackgroundColor || props.theme.backgroundColor;
 }, function (props) {
@@ -117,12 +91,11 @@ var StyledDxcChip = _styledComponents["default"].div(_templateObject || (_templa
   return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.bottom ? _variables.spaces[props.margin.bottom] : "";
 }, function (props) {
   return props.margin && (0, _typeof2["default"])(props.margin) === "object" && props.margin.left ? _variables.spaces[props.margin.left] : "";
-}, function (_ref3) {
-  var disabled = _ref3.disabled;
+}, function (_ref2) {
+  var disabled = _ref2.disabled;
   return disabled && "not-allowed";
 });
-
-var ChipTextContainer = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  font-size: ", ";\n  font-family: ", ";\n  font-weight: ", ";\n  font-style: ", ";\n  color: ", ";\n  cursor: ", ";\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  overflow: hidden;\n"])), function (props) {
+var LabelContainer = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  font-size: ", ";\n  font-family: ", ";\n  font-weight: ", ";\n  font-style: ", ";\n  color: ", ";\n  text-overflow: ellipsis;\n  white-space: nowrap;\n  overflow: hidden;\n"])), function (props) {
   return props.theme.fontSize;
 }, function (props) {
   return props.theme.fontFamily;
@@ -132,30 +105,17 @@ var ChipTextContainer = _styledComponents["default"].span(_templateObject2 || (_
   return props.theme.fontStyle;
 }, function (props) {
   return props.disabled ? props.theme.disabledFontColor : props.theme.fontColor;
-}, function (_ref4) {
-  var disabled = _ref4.disabled;
-  return disabled && "not-allowed" || "default";
 });
-
-var SuffixIconContainer = _styledComponents["default"].img(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])([""])));
-
-var PrefixIconContainer = _styledComponents["default"].img(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])([""])));
-
-var IconContainer = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  ", "\n  ", "\n  width: ", ";\n  height: ", ";\n  overflow: hidden;\n\n  img,\n  svg {\n    height: 100%;\n    width: 100%;\n  }\n  &:focus {\n    outline-color: ", ";\n    outline-width: 2px;\n    ", "\n  }\n"])), function (props) {
+var IconContainer = _styledComponents["default"].div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  border-radius: 0.25rem;\n  color: ", ";\n  ", "\n\n  ", "\n\n  img,\n  svg {\n    width: ", ";\n    height: ", ";\n  }\n"])), function (props) {
   return props.disabled ? props.theme.disabledIconColor : props.theme.iconColor;
+}, function (_ref3) {
+  var interactuable = _ref3.interactuable;
+  return interactuable && "cursor: pointer;";
 }, function (props) {
-  return props.prefixIcon ? "margin-right: ".concat((props.label || props.suffixIcon) && props.theme.iconSpacing || props.prefixIcon && "0", ";") : "margin-left: ".concat((props.label || props.prefixIcon) && props.theme.iconSpacing || props.prefixIcon && "0", ";");
-}, function (props) {
-  return getCursor(props.interactuable, props.disabled);
+  return props.interactuable && "\n      &:hover {\n        color: ".concat(props.theme.hoverIconColor, ";\n      }\n      &:focus,\n      &:focus-visible {\n        outline: ").concat(props.theme.focusBorderThickness, " ").concat(props.theme.focusBorderStyle, " ").concat(props.theme.focusColor, ";\n      }\n      &:active {\n        color: ").concat(props.theme.activeIconColor, ";\n      }\n    ");
 }, function (props) {
   return props.theme.iconSize;
 }, function (props) {
   return props.theme.iconSize;
-}, function (props) {
-  return props.theme.focusColor;
-}, function (props) {
-  return props.disabled && "outline: none;";
 });
-
-var _default = DxcChip;
-exports["default"] = _default;
+var _default = exports["default"] = DxcChip;