@dxc-technology/halstack-react 0.0.0-2c3a5e1 → 0.0.0-2c7db3b

package/radio-group/RadioGroup.accessibility.test.js

@@ -0,0 +1,97 @@
+"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 _axeHelper = require("../../test/accessibility/axe-helper.js");
+var _RadioGroup = _interopRequireDefault(require("./RadioGroup"));
+var options = [{
+  label: "Option 01",
+  value: "1"
+}, {
+  label: "Option 02",
+  value: "2"
+}, {
+  label: "Option 03",
+  value: "3"
+}, {
+  label: "Option 04",
+  value: "4"
+}, {
+  label: "Option 05",
+  value: "5",
+  disabled: true
+}, {
+  label: "Option 06",
+  value: "6",
+  disabled: true
+}, {
+  label: "Option 07",
+  value: "7",
+  disabled: true
+}, {
+  label: "Option 08",
+  value: "8",
+  disabled: true
+}, {
+  label: "Option 09",
+  value: "9"
+}];
+describe("Radio Group 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(_RadioGroup["default"], {
+            label: "test-radioGroup-label",
+            options: options,
+            error: "Error",
+            defaultValue: "3",
+            helperText: "Helper Text",
+            name: "Name",
+            stacking: "row",
+            optionalItemLabel: "Optional",
+            optional: true
+          })), container = _render.container;
+          _context.next = 3;
+          return (0, _axeHelper.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(_RadioGroup["default"], {
+            label: "test-radioGroup-label",
+            options: options,
+            error: "Error",
+            defaultValue: "3",
+            helperText: "Helper Text",
+            name: "Name",
+            stacking: "row",
+            optionalItemLabel: "Optional",
+            readOnly: true
+          })), container = _render2.container;
+          _context2.next = 3;
+          return (0, _axeHelper.axe)(container);
+        case 3:
+          results = _context2.sent;
+          expect(results).toHaveNoViolations();
+        case 5:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+});

package/radio-group/RadioGroup.js

@@ -1,173 +1,139 @@
 "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 _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
-
-var _uuid = require("uuid");
-
 var _useTheme = _interopRequireDefault(require("../useTheme"));
-
+var _useTranslatedLabels = _interopRequireDefault(require("../useTranslatedLabels"));
 var _Radio = _interopRequireDefault(require("./Radio"));
-
 var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7;
-
-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; }
-
+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 getInitialFocusIndex = function getInitialFocusIndex(innerOptions, value) {
   var initialSelectedOptionIndex = innerOptions.findIndex(function (option) {
     return option.value === value;
   });
   return initialSelectedOptionIndex !== -1 ? initialSelectedOptionIndex : 0;
 };
-
 var DxcRadioGroup = /*#__PURE__*/_react["default"].forwardRef(function (_ref, ref) {
+  var _ref2;
   var label = _ref.label,
-      name = _ref.name,
-      helperText = _ref.helperText,
-      options = _ref.options,
-      _ref$disabled = _ref.disabled,
-      disabled = _ref$disabled === void 0 ? false : _ref$disabled,
-      _ref$optional = _ref.optional,
-      optional = _ref$optional === void 0 ? false : _ref$optional,
-      _ref$optionalItemLabe = _ref.optionalItemLabel,
-      optionalItemLabel = _ref$optionalItemLabe === void 0 ? "N/A" : _ref$optionalItemLabe,
-      _ref$readonly = _ref.readonly,
-      readonly = _ref$readonly === void 0 ? false : _ref$readonly,
-      _ref$stacking = _ref.stacking,
-      stacking = _ref$stacking === void 0 ? "column" : _ref$stacking,
-      defaultValue = _ref.defaultValue,
-      value = _ref.value,
-      onChange = _ref.onChange,
-      onBlur = _ref.onBlur,
-      error = _ref.error;
-
-  var _useState = (0, _react.useState)("radio-group-".concat((0, _uuid.v4)())),
-      _useState2 = (0, _slicedToArray2["default"])(_useState, 1),
-      radioGroupId = _useState2[0];
-
+    name = _ref.name,
+    helperText = _ref.helperText,
+    options = _ref.options,
+    _ref$disabled = _ref.disabled,
+    disabled = _ref$disabled === void 0 ? false : _ref$disabled,
+    _ref$optional = _ref.optional,
+    optional = _ref$optional === void 0 ? false : _ref$optional,
+    optionalItemLabel = _ref.optionalItemLabel,
+    _ref$readOnly = _ref.readOnly,
+    readOnly = _ref$readOnly === void 0 ? false : _ref$readOnly,
+    _ref$stacking = _ref.stacking,
+    stacking = _ref$stacking === void 0 ? "column" : _ref$stacking,
+    defaultValue = _ref.defaultValue,
+    value = _ref.value,
+    onChange = _ref.onChange,
+    onBlur = _ref.onBlur,
+    error = _ref.error,
+    _ref$tabIndex = _ref.tabIndex,
+    tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
+  var radioGroupId = "radio-group-".concat((0, _react.useId)());
   var radioGroupLabelId = "label-".concat(radioGroupId);
   var errorId = "error-".concat(radioGroupId);
-
-  var _useState3 = (0, _react.useState)(defaultValue),
-      _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
-      innerValue = _useState4[0],
-      setInnerValue = _useState4[1];
-
-  var _useState5 = (0, _react.useState)(true),
-      _useState6 = (0, _slicedToArray2["default"])(_useState5, 2),
-      firstTimeFocus = _useState6[0],
-      setFirstTimeFocus = _useState6[1];
-
-  var optionalItem = {
-    label: optionalItemLabel,
-    value: "",
-    disabled: disabled
-  };
-  var innerOptions = (0, _react.useMemo)(function () {
-    return optional ? [].concat((0, _toConsumableArray2["default"])(options), [optionalItem]) : options;
-  }, [optional, options]);
-
-  var _useState7 = (0, _react.useState)(getInitialFocusIndex(innerOptions, value !== null && value !== void 0 ? value : innerValue)),
-      _useState8 = (0, _slicedToArray2["default"])(_useState7, 2),
-      currentFocusIndex = _useState8[0],
-      setCurrentFocusIndex = _useState8[1];
-
+  var _useState = (0, _react.useState)(defaultValue),
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+    innerValue = _useState2[0],
+    setInnerValue = _useState2[1];
+  var _useState3 = (0, _react.useState)(true),
+    _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+    firstTimeFocus = _useState4[0],
+    setFirstTimeFocus = _useState4[1];
   var colorsTheme = (0, _useTheme["default"])();
+  var translatedLabels = (0, _useTranslatedLabels["default"])();
+  var innerOptions = (0, _react.useMemo)(function () {
+    return optional ? [].concat((0, _toConsumableArray2["default"])(options), [{
+      label: optionalItemLabel !== null && optionalItemLabel !== void 0 ? optionalItemLabel : translatedLabels.radioGroup.optionalItemLabelDefault,
+      value: "",
+      disabled: disabled
+    }]) : options;
+  }, [optional, options, optionalItemLabel, translatedLabels]);
+  var _useState5 = (0, _react.useState)(getInitialFocusIndex(innerOptions, value !== null && value !== void 0 ? value : innerValue)),
+    _useState6 = (0, _slicedToArray2["default"])(_useState5, 2),
+    currentFocusIndex = _useState6[0],
+    setCurrentFocusIndex = _useState6[1];
   var handleOnChange = (0, _react.useCallback)(function (newValue) {
     var currentValue = value !== null && value !== void 0 ? value : innerValue;
-
-    if (newValue !== currentValue && !readonly) {
+    if (newValue !== currentValue && !readOnly) {
       value !== null && value !== void 0 ? value : setInnerValue(newValue);
       onChange === null || onChange === void 0 ? void 0 : onChange(newValue);
     }
-  }, [value, innerValue, setInnerValue, onChange]);
-
-  var handleOnBlur = function handleOnBlur(e) {
+  }, [value, innerValue, onChange]);
+  var handleOnBlur = function handleOnBlur(event) {
     // If the radio group loses the focus to an element not contained inside it...
-    !e.currentTarget.contains(e.relatedTarget) && setFirstTimeFocus(true);
-    var currentValue = value !== null && value !== void 0 ? value : innerValue;
-    !optional && !Boolean(currentValue) ? onBlur === null || onBlur === void 0 ? void 0 : onBlur({
-      value: currentValue,
-      error: "This field is required. Please, choose an option."
-    }) : onBlur === null || onBlur === void 0 ? void 0 : onBlur({
-      value: currentValue
-    });
-  };
-
-  var setPreviousRadioChecked = function setPreviousRadioChecked() {
-    if (!disabled) {
-      setCurrentFocusIndex(function (currentFocusIndex) {
-        var index = currentFocusIndex === 0 ? innerOptions.length - 1 : currentFocusIndex - 1;
-
-        while (innerOptions[index].disabled) {
-          index = index === 0 ? innerOptions.length - 1 : index - 1;
-        }
-
-        return index;
+    if (!event.currentTarget.contains(event.relatedTarget)) {
+      setFirstTimeFocus(true);
+      var currentValue = value !== null && value !== void 0 ? value : innerValue;
+      !optional && !Boolean(currentValue) ? onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+        value: currentValue,
+        error: translatedLabels.formFields.requiredSelectionErrorMessage
+      }) : onBlur === null || onBlur === void 0 ? void 0 : onBlur({
+        value: currentValue
       });
     }
   };
-
+  var handleOnFocus = function handleOnFocus() {
+    firstTimeFocus && setFirstTimeFocus(false);
+  };
+  var setPreviousRadioChecked = function setPreviousRadioChecked() {
+    setCurrentFocusIndex(function (currentFocusIndex) {
+      var index = currentFocusIndex === 0 ? innerOptions.length - 1 : currentFocusIndex - 1;
+      while (innerOptions[index].disabled) {
+        index = index === 0 ? innerOptions.length - 1 : index - 1;
+      }
+      handleOnChange(innerOptions[index].value);
+      return index;
+    });
+  };
   var setNextRadioChecked = function setNextRadioChecked() {
-    if (!disabled) {
-      setCurrentFocusIndex(function (currentFocusIndex) {
-        var index = currentFocusIndex === innerOptions.length - 1 ? 0 : currentFocusIndex + 1;
-
-        while (innerOptions[index].disabled) {
-          index = index === innerOptions.length - 1 ? 0 : index + 1;
-        }
-
-        return index;
-      });
-    }
+    setCurrentFocusIndex(function (currentFocusIndex) {
+      var index = currentFocusIndex === innerOptions.length - 1 ? 0 : currentFocusIndex + 1;
+      while (innerOptions[index].disabled) {
+        index = index === innerOptions.length - 1 ? 0 : index + 1;
+      }
+      handleOnChange(innerOptions[index].value);
+      return index;
+    });
   };
-
   var handleOnKeyDown = function handleOnKeyDown(event) {
-    switch (event.keyCode) {
-      case 37: // arrow left
-
-      case 38:
-        // arrow up
+    switch (event.key) {
+      case "Left":
+      case "ArrowLeft":
+      case "Up":
+      case "ArrowUp":
         event.preventDefault();
         setPreviousRadioChecked();
         break;
-
-      case 39: // arrow right
-
-      case 40:
-        // arrow down
+      case "Right":
+      case "ArrowRight":
+      case "Down":
+      case "ArrowDown":
         event.preventDefault();
         setNextRadioChecked();
         break;
-
-      case 13: // enter
-
-      case 32:
-        // space
+      case " ":
         event.preventDefault();
         handleOnChange(innerOptions[currentFocusIndex].value);
         break;
     }
   };
-
   return /*#__PURE__*/_react["default"].createElement(_styledComponents.ThemeProvider, {
     theme: colorsTheme.radioGroup
   }, /*#__PURE__*/_react["default"].createElement(RadioGroupContainer, {
@@ -176,47 +142,48 @@ var DxcRadioGroup = /*#__PURE__*/_react["default"].forwardRef(function (_ref, re
     id: radioGroupLabelId,
     helperText: helperText,
     disabled: disabled
-  }, label, " ", optional && /*#__PURE__*/_react["default"].createElement(OptionalLabel, null, "(Optional)")), helperText && /*#__PURE__*/_react["default"].createElement(HelperText, {
+  }, label, optional && /*#__PURE__*/_react["default"].createElement(OptionalLabel, null, " ".concat(translatedLabels.formFields.optionalLabel))), helperText && /*#__PURE__*/_react["default"].createElement(HelperText, {
     disabled: disabled
   }, helperText), /*#__PURE__*/_react["default"].createElement(RadioGroup, {
     onBlur: handleOnBlur,
+    onFocus: handleOnFocus,
     onKeyDown: handleOnKeyDown,
     stacking: stacking,
     role: "radiogroup",
     "aria-disabled": disabled,
     "aria-labelledby": radioGroupLabelId,
-    "aria-invalid": error ? "true" : "false",
+    "aria-invalid": error ? true : false,
     "aria-errormessage": error ? errorId : undefined,
-    "aria-required": !optional
+    "aria-required": !disabled && !readOnly && !optional,
+    "aria-readonly": readOnly,
+    "aria-orientation": stacking === "column" ? "vertical" : "horizontal"
   }, /*#__PURE__*/_react["default"].createElement(ValueInput, {
     name: name,
-    value: value !== null && value !== void 0 ? value : innerValue,
-    readOnly: true,
-    "aria-hidden": "true"
+    disabled: disabled,
+    value: (_ref2 = value !== null && value !== void 0 ? value : innerValue) !== null && _ref2 !== void 0 ? _ref2 : "",
+    readOnly: true
   }), innerOptions.map(function (option, index) {
     return /*#__PURE__*/_react["default"].createElement(_Radio["default"], {
-      option: option,
-      currentValue: value !== null && value !== void 0 ? value : innerValue,
+      key: "radio-".concat(index),
+      label: option.label,
+      checked: (value !== null && value !== void 0 ? value : innerValue) === option.value,
       onClick: function onClick() {
         handleOnChange(option.value);
         setCurrentFocusIndex(index);
       },
-      onFocus: function onFocus() {
-        !firstTimeFocus ? handleOnChange(option.value) : setFirstTimeFocus(false);
-      },
       error: error,
       disabled: option.disabled || disabled,
       focused: currentFocusIndex === index,
-      readonly: readonly
+      readOnly: readOnly,
+      tabIndex: tabIndex
     });
   })), !disabled && typeof error === "string" && /*#__PURE__*/_react["default"].createElement(Error, {
     id: errorId,
+    role: "alert",
     "aria-live": error ? "assertive" : "off"
   }, error)));
 });
-
-var RadioGroupContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  display: inline-flex;\n  flex-direction: column;\n  box-sizing: border-box;\n"])));
-
+var RadioGroupContainer = _styledComponents["default"].div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["\n  box-sizing: border-box;\n  display: inline-flex;\n  flex-direction: column;\n"])));
 var Label = _styledComponents["default"].span(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n  ", "\n"])), function (props) {
   return props.disabled ? props.theme.disabledLabelFontColor : props.theme.labelFontColor;
 }, function (props) {
@@ -232,11 +199,9 @@ var Label = _styledComponents["default"].span(_templateObject2 || (_templateObje
 }, function (props) {
   return !props.helperText && "margin-bottom: ".concat(props.theme.groupLabelMargin);
 });
-
 var OptionalLabel = _styledComponents["default"].span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["\n  font-weight: ", ";\n"])), function (props) {
   return props.theme.optionalLabelFontWeight;
 });
-
 var HelperText = _styledComponents["default"].span(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["\n  color: ", ";\n  font-family: ", ";\n  font-size: ", ";\n  font-style: ", ";\n  font-weight: ", ";\n  line-height: ", ";\n  margin-bottom: ", ";\n"])), function (props) {
   return props.disabled ? props.theme.disabledHelperTextFontColor : props.theme.helperTextFontColor;
 }, function (props) {
@@ -252,22 +217,17 @@ var HelperText = _styledComponents["default"].span(_templateObject4 || (_templat
 }, function (props) {
   return props.theme.groupLabelMargin;
 });
-
-var RadioGroup = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-wrap: wrap;\n  flex-direction: ", ";\n\n  row-gap: ", ";\n  column-gap: ", ";\n"])), function (props) {
+var RadioGroup = _styledComponents["default"].div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["\n  display: flex;\n  flex-wrap: wrap;\n  flex-direction: ", ";\n  row-gap: ", ";\n  column-gap: ", ";\n"])), function (props) {
   return props.stacking;
 }, function (props) {
   return props.theme.groupVerticalGutter;
 }, function (props) {
   return props.theme.groupHorizontalGutter;
 });
-
 var ValueInput = _styledComponents["default"].input(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["\n  display: none;\n"])));
-
 var Error = _styledComponents["default"].span(_templateObject7 || (_templateObject7 = (0, _taggedTemplateLiteral2["default"])(["\n  min-height: 1.5em;\n  color: ", ";\n  font-family: ", ";\n  font-size: 0.75rem;\n  font-weight: 400;\n  line-height: 1.5em;\n  margin-top: 0.5rem;\n"])), function (props) {
   return props.theme.errorMessageColor;
 }, function (props) {
   return props.theme.fontFamily;
 });
-
-var _default = DxcRadioGroup;
-exports["default"] = _default;
+var _default = exports["default"] = DxcRadioGroup;