@dxc-technology/halstack-react 0.0.0-28a98e5 → 0.0.0-293a019

package/checkbox/Checkbox.test.js

@@ -0,0 +1,155 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _react = _interopRequireDefault(require("react"));
+
+var _react2 = require("@testing-library/react");
+
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+
+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;
+
+    var labelId = getByText("Checkbox").getAttribute("id");
+    expect(getByRole("checkbox").getAttribute("aria-labelledby")).toBe(labelId);
+    expect(getByRole("checkbox").getAttribute("aria-required")).toBe("true");
+  });
+  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;
+
+    expect(getByRole("checkbox").getAttribute("aria-required")).toBe("false");
+  });
+  test("Calls correct function on click", function () {
+    var onChange = jest.fn();
+
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      onChange: onChange
+    })),
+        getByText = _render3.getByText;
+
+    _react2.fireEvent.click(getByText("Checkbox"));
+
+    expect(onChange).toHaveBeenCalled();
+  });
+  test("Uncontrolled checkbox", function () {
+    var onChange = jest.fn();
+    var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      onChange: onChange,
+      name: "test"
+    }));
+    var visibleCheckbox = component.getByText("Checkbox");
+    var input = component.getByRole("checkbox");
+    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");
+    expect(submitInput.checked).toBe(true);
+  });
+  test("Controlled checkbox", function () {
+    var onChange = jest.fn();
+    var component = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+      label: "Checkbox",
+      checked: false,
+      onChange: onChange,
+      name: "test"
+    }));
+    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 checkbox = getByRole("checkbox");
+    var submitInput = container.querySelector("input[name=\"test\"]");
+    expect(submitInput.value).toBe("test-defaultChecked");
+    expect(checkbox.getAttribute("aria-checked")).toBe("true");
+    expect(submitInput.checked).toBe(true);
+  });
+  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 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 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

@@ -0,0 +1,68 @@
+declare type Space = "xxsmall" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxlarge";
+declare type Margin = {
+    top?: Space;
+    bottom?: Space;
+    left?: Space;
+    right?: Space;
+};
+declare type Props = {
+    /**
+     * Initial state of the checkbox, only when it is uncontrolled.
+     */
+    defaultChecked?: boolean;
+    /**
+     * If true, the component is checked. If undefined the component will be
+     * uncontrolled and the value will be managed internally by the component.
+     */
+    checked?: boolean;
+    /**
+     * Will be passed to the value attribute of the html input element.
+     * When inside a form, this value will be only submitted if the checkbox is checked.
+     */
+    value?: string;
+    /**
+     * Text to be placed next to the checkbox.
+     */
+    label?: string;
+    /**
+     * Whether the label should appear after or before the checkbox.
+     */
+    labelPosition?: "before" | "after";
+    /**
+     * Name attribute of the input element.
+     */
+    name?: string;
+    /**
+     * If true, the component will be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * If true, the component will display '(Optional)' next to the label.
+     */
+    optional?: boolean;
+    /**
+     * This function will be called when the user clicks the checkbox.
+     * The new value will be passed as a parameter.
+     */
+    onChange?: (value: boolean) => void;
+    /**
+     * 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" | "fitContent";
+    /**
+     * Value of the tabindex.
+     */
+    tabIndex?: number;
+};
+/**
+ * Reference to the component.
+ */
+export declare type RefType = HTMLDivElement;
+export default Props;

package/checkbox/types.js

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

package/chip/Chip.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import ChipPropsType from "./types";
+declare const DxcChip: ({ label, suffixIcon, prefixIcon, onClickSuffix, onClickPrefix, disabled, margin, tabIndex, }: ChipPropsType) => JSX.Element;
+export default DxcChip;

package/chip/Chip.js

@@ -9,25 +9,21 @@ 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"));
 
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
 var _react = _interopRequireDefault(require("react"));
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
+var _variables = require("../common/variables");
 
-var _variables = require("../common/variables.js");
+var _utils = require("../common/utils");
 
-var _utils = require("../common/utils.js");
+var _useTheme = _interopRequireDefault(require("../useTheme"));
 
-var _useTheme = _interopRequireDefault(require("../useTheme.js"));
-
-var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+var _templateObject, _templateObject2, _templateObject3;
 
 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); }
 
@@ -37,9 +33,7 @@ var DxcChip = function DxcChip(_ref) {
   var label = _ref.label,
       suffixIcon = _ref.suffixIcon,
       prefixIcon = _ref.prefixIcon,
-      suffixIconSrc = _ref.suffixIconSrc,
       onClickSuffix = _ref.onClickSuffix,
-      prefixIconSrc = _ref.prefixIconSrc,
       onClickPrefix = _ref.onClickPrefix,
       disabled = _ref.disabled,
       margin = _ref.margin,
@@ -48,69 +42,42 @@ var DxcChip = function DxcChip(_ref) {
   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, {
-    disabled: disabled,
-    prefixIcon: true,
-    label: label,
-    mode: "prefix",
-    tabIndex: typeof onClickPrefix === "function" && !disabled ? tabIndex : -1,
-    onClick: function onClick() {
-      return onClickPrefix && !disabled && onClickPrefix(label);
-    },
-    interactuable: typeof onClickPrefix === "function" && !disabled
-  }, (0, _typeof2["default"])(prefixIcon) === "object" ? prefixIcon : /*#__PURE__*/_react["default"].createElement(prefixIcon)) : prefixIconSrc && /*#__PURE__*/_react["default"].createElement(PrefixIconContainer, {
+  }, prefixIcon && /*#__PURE__*/_react["default"].createElement(IconContainer, {
+    role: typeof onClickPrefix === "function" ? "button" : undefined,
     disabled: disabled,
-    src: prefixIconSrc,
-    label: label,
+    interactuable: typeof onClickPrefix === "function" && !disabled,
     tabIndex: typeof onClickPrefix === "function" && !disabled ? tabIndex : -1,
     onClick: function onClick() {
-      return onClickPrefix && !disabled && onClickPrefix(label);
-    },
-    interactuable: typeof onClickPrefix === "function" && !disabled
-  }), label && /*#__PURE__*/_react["default"].createElement(ChipTextContainer, {
-    disabled: disabled,
-    prefixIconSrc: prefixIconSrc,
-    suffixIconSrc: suffixIconSrc
-  }, label), suffixIcon ? /*#__PURE__*/_react["default"].createElement(IconContainer, {
+      return onClickPrefix && !disabled && onClickPrefix();
+    }
+  }, typeof prefixIcon === "string" ? /*#__PURE__*/_react["default"].createElement("img", {
+    src: prefixIcon
+  }) : 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(label);
-    },
-    interactuable: typeof onClickSuffix === "function" && !disabled
-  }, (0, _typeof2["default"])(suffixIcon) === "object" ? suffixIcon : /*#__PURE__*/_react["default"].createElement(suffixIcon)) : suffixIconSrc && /*#__PURE__*/_react["default"].createElement(SuffixIconContainer, {
-    disabled: disabled,
-    src: suffixIconSrc,
-    label: label,
-    tabIndex: typeof onClickSuffix === "function" && !disabled ? tabIndex : -1,
-    onClick: function onClick() {
-      return onClickSuffix && !disabled && onClickSuffix(label);
-    },
-    interactuable: typeof onClickSuffix === "function" && !disabled
-  })));
+      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) {
@@ -139,12 +106,12 @@ 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;
@@ -154,68 +121,20 @@ 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"])(["\n  color: ", ";\n  ", "\n  margin-left: ", ";\n  width: ", ";\n  height: ", ";\n"])), function (props) {
-  return props.disabled ? props.theme.disabledIconColor : props.theme.iconColor;
-}, function (props) {
-  return getCursor(props.interactuable, props.disabled);
-}, function (props) {
-  return (props.label || props.suffixIconSrc) && props.theme.iconSpacing || props.prefixIconSrc && "5px";
-}, function (props) {
-  return props.theme.iconSize;
-}, function (props) {
-  return props.theme.iconSize;
 });
 
-var PrefixIconContainer = _styledComponents["default"].img(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  ", "\n  margin-right: ", ";\n  width: ", ";\n  height: ", ";\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 getCursor(props.interactuable, props.disabled);
-}, function (props) {
-  return (props.label || props.suffixIconSrc) && props.theme.iconSpacing || props.prefixIconSrc && "5px";
-}, function (props) {
-  return props.theme.iconSize;
-}, function (props) {
-  return props.theme.iconSize;
-});
-
-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) {
-  return props.disabled ? props.theme.disabledIconColor : props.theme.iconColor;
-}, function (props) {
-  return props.prefixIcon ? "margin-right: ".concat((props.label || props.suffixIcon || props.suffixIconSrc) && props.theme.iconSpacing || (props.prefixIcon || props.prefixIconSrc) && "0", ";") : "margin-left: ".concat((props.label || props.prefixIcon || props.prefixIconSrc) && props.theme.iconSpacing || (props.prefixIcon || props.prefixIconSrc) && "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, " solid ").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;";
 });
 
-DxcChip.propTypes = {
-  label: _propTypes["default"].string,
-  disabled: _propTypes["default"].bool,
-  theme: _propTypes["default"].oneOf(["dark", "light"]),
-  suffixIcon: _propTypes["default"].oneOfType([_propTypes["default"].element, _propTypes["default"].func]),
-  prefixIcon: _propTypes["default"].oneOfType([_propTypes["default"].element, _propTypes["default"].func]),
-  suffixIconSrc: _propTypes["default"].string,
-  prefixIconSrc: _propTypes["default"].string,
-  onClickSuffix: _propTypes["default"].func,
-  onClickPrefix: _propTypes["default"].func,
-  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)))]),
-  tabIndex: _propTypes["default"].number
-};
 var _default = DxcChip;
 exports["default"] = _default;