@dxc-technology/halstack-react 10.1.0 → 11.0.0

package/dialog/Dialog.test.js

@@ -1,35 +1,20 @@
 "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 _Dialog = _interopRequireDefault(require("./Dialog.tsx"));
-
 var _TextInput = _interopRequireDefault(require("../text-input/TextInput.tsx"));
-
 var _Textarea = _interopRequireDefault(require("../textarea/Textarea.tsx"));
-
 var _Checkbox = _interopRequireDefault(require("../checkbox/Checkbox.tsx"));
-
 var _Select = _interopRequireDefault(require("../select/Select.tsx"));
-
 var _Button = _interopRequireDefault(require("../button/Button.tsx"));
-
 var _Link = _interopRequireDefault(require("../link/Link.tsx"));
-
 var _Card = _interopRequireDefault(require("../card/Card.tsx"));
-
 var _RadioGroup = _interopRequireDefault(require("../radio-group/RadioGroup.tsx"));
-
 var _Slider = _interopRequireDefault(require("../slider/Slider.tsx"));
-
 var _Switch = _interopRequireDefault(require("../switch/Switch.tsx"));
-
 var options = [{
   label: "Female",
   value: "female"
@@ -46,324 +31,277 @@ var options = [{
 describe("Dialog component tests", function () {
   test("Dialog renders with correct text and accesibility attributes", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, "dialog-text")),
-        getByText = _render.getByText,
-        getByRole = _render.getByRole;
-
+      getByText = _render.getByText,
+      getByRole = _render.getByRole;
     expect(getByRole("dialog")).toBeTruthy();
     expect(getByRole("dialog").getAttribute("aria-modal")).toBe("true");
     expect(getByText("dialog-text")).toBeTruthy();
   });
   test("Dialog renders without close button", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
-      isCloseVisible: false
-    }, "dialog-text")),
-        queryByRole = _render2.queryByRole;
-
+        isCloseVisible: false
+      }, "dialog-text")),
+      queryByRole = _render2.queryByRole;
     expect(queryByRole("button")).toBeFalsy();
   });
   test("Dialog renders with aria-modal false when overlay is not used", function () {
     var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
-      isCloseVisible: false,
-      overlay: false
-    }, "dialog-text")),
-        getByRole = _render3.getByRole;
-
+        isCloseVisible: false,
+        overlay: false
+      }, "dialog-text")),
+      getByRole = _render3.getByRole;
     expect(getByRole("dialog")).toBeTruthy();
     expect(getByRole("dialog").getAttribute("aria-modal")).toBe("false");
   });
   test("Calls correct function onCloseClick", function () {
     var onCloseClick = jest.fn();
-
     var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
-      onCloseClick: onCloseClick
-    }, "dialog-text")),
-        getByRole = _render4.getByRole;
-
+        onCloseClick: onCloseClick
+      }, "dialog-text")),
+      getByRole = _render4.getByRole;
     var closeButton = getByRole("button");
-
     _react2.fireEvent.click(closeButton);
-
     expect(onCloseClick).toHaveBeenCalled();
   });
   test("Calls correct function onCloseClick when 'Escape' key is pressed", function () {
     var onCloseClick = jest.fn();
-
     var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
-      onCloseClick: onCloseClick
-    }, "dialog-text")),
-        getByRole = _render5.getByRole;
-
+        onCloseClick: onCloseClick
+      }, "dialog-text")),
+      getByRole = _render5.getByRole;
     _react2.fireEvent.keyDown(getByRole("dialog"), {
       key: "Escape",
       code: "Escape",
       keyCode: 27,
       charCode: 27
     });
-
     expect(onCloseClick).toHaveBeenCalled();
   });
 });
 describe("Dialog component: Focus lock tests", function () {
   test("Close action: when there's no focusable content, the focus never leaves the close action (unless you click outside)", function () {
     var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, "example-dialog")),
-        getByRole = _render6.getByRole;
-
+      getByRole = _render6.getByRole;
     var button = getByRole("button");
     var dialog = getByRole("dialog");
     expect(document.activeElement).toEqual(button);
     expect(button.getAttribute("aria-label")).toBe("Close dialog");
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(button);
-
     _react2.fireEvent.keyDown(dialog, {
       key: "Tab",
       shiftKey: true
     });
-
     expect(document.activeElement).toEqual(button);
   });
   test("Autofocus with Button component", function () {
     var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Button["default"], {
-      label: "Accept"
-    }))),
-        getAllByRole = _render7.getAllByRole;
-
+        label: "Accept"
+      }))),
+      getAllByRole = _render7.getAllByRole;
     var button = getAllByRole("button")[0];
     expect(document.activeElement).toEqual(button);
     expect(button.getAttribute("aria-label")).not.toBe("Close dialog");
   });
   test("Autofocus with Card component", function () {
     var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Card["default"], {
-      linkHref: "https://developer.dxc.com/halstack/next/components/card/"
-    }, "example-card"))),
-        getByRole = _render8.getByRole;
-
+        linkHref: "https://developer.dxc.com/halstack/next/components/card/"
+      }, "example-card"))),
+      getByRole = _render8.getByRole;
     var card = getByRole("link");
     expect(document.activeElement).toEqual(card);
   });
   test("Autofocus with Checkbox component", function () {
     var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Name"
-    }))),
-        getByRole = _render9.getByRole;
-
+        label: "Name"
+      }))),
+      getByRole = _render9.getByRole;
     var checkbox = getByRole("checkbox");
     expect(document.activeElement).toEqual(checkbox);
   });
   test("Autofocus with Link component", function () {
     var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, "This is a text with a ", /*#__PURE__*/_react["default"].createElement(_Link["default"], {
-      href: "#"
-    }, "Link"), " to another page.")),
-        getByRole = _render10.getByRole;
-
+        href: "#"
+      }, "Link"), " to another page.")),
+      getByRole = _render10.getByRole;
     var link = getByRole("link");
     expect(document.activeElement).toEqual(link);
   });
   test("Autofocus with RadioGroup component", function () {
     var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
-      label: "Example",
-      options: options
-    }))),
-        getAllByRole = _render11.getAllByRole;
-
+        label: "Example",
+        options: options
+      }))),
+      getAllByRole = _render11.getAllByRole;
     var checkedRadio = getAllByRole("radio")[0];
     expect(document.activeElement).toEqual(checkedRadio);
   });
   test("Autofocus with Select component", function () {
     var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Select["default"], {
-      label: "Country",
-      options: options
-    }))),
-        getByRole = _render12.getByRole;
-
+        label: "Country",
+        options: options
+      }))),
+      getByRole = _render12.getByRole;
     var select = getByRole("combobox");
     expect(document.activeElement).toEqual(select);
   });
   test("Autofocus with Slider component", function () {
     var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Slider["default"], {
-      label: "label",
-      minValue: 0,
-      maxValue: 100,
-      showLimitsValues: true
-    }))),
-        getByRole = _render13.getByRole;
-
+        label: "label",
+        minValue: 0,
+        maxValue: 100,
+        showLimitsValues: true
+      }))),
+      getByRole = _render13.getByRole;
     var slider = getByRole("slider");
     expect(document.activeElement).toEqual(slider);
   });
   test("Autofocus with Switch component", function () {
     var _render14 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Switch["default"], {
-      label: "Example"
-    }))),
-        getByRole = _render14.getByRole;
-
+        label: "Example"
+      }))),
+      getByRole = _render14.getByRole;
     var switchButton = getByRole("switch");
     expect(document.activeElement).toEqual(switchButton);
   });
   test("Autofocus with Text Input component", function () {
     var _render15 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
-      label: "Name"
-    }))),
-        getByRole = _render15.getByRole;
-
+        label: "Name"
+      }))),
+      getByRole = _render15.getByRole;
     var input = getByRole("textbox");
     expect(document.activeElement).toEqual(input);
   });
   test("Autofocus with Textarea component", function () {
     var _render16 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Textarea["default"], {
-      label: "Name"
-    }))),
-        getByRole = _render16.getByRole;
-
+        label: "Name"
+      }))),
+      getByRole = _render16.getByRole;
     var textarea = getByRole("textbox");
     expect(document.activeElement).toEqual(textarea);
   });
   test("Negative tabindex elements are not automatically focused, even if it is enabled and a valid focusable item (programatically and by click)", function () {
     var _render17 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement("input", {
-      label: "Name",
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement("input", {
-      label: "Name"
-    }))),
-        getAllByRole = _render17.getAllByRole,
-        getByRole = _render17.getByRole;
-
+        label: "Name",
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement("input", {
+        label: "Name"
+      }))),
+      getAllByRole = _render17.getAllByRole,
+      getByRole = _render17.getByRole;
     var inputs = getAllByRole("textbox");
     var button = getByRole("button");
     expect(document.activeElement).toEqual(inputs[1]);
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(button);
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(inputs[1]);
   });
   test("Focus jumps disabled components and negative tabIndexes when autofocusing first item", function () {
     var _render18 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Button["default"], {
-      label: "Accept",
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Older age",
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_Select["default"], {
-      label: "Country",
-      options: options,
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
-      label: "Country",
-      options: options,
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
-      label: "Name",
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_Button["default"], {
-      label: "Accept",
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Older age",
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement(_Select["default"], {
-      label: "Country",
-      options: options,
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
-      label: "Country",
-      options: options,
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
-      label: "Name",
-      tabIndex: -1
-    }), /*#__PURE__*/_react["default"].createElement(_Textarea["default"], {
-      label: "Description"
-    }))),
-        getAllByRole = _render18.getAllByRole;
-
+        label: "Accept",
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Older age",
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_Select["default"], {
+        label: "Country",
+        options: options,
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+        label: "Country",
+        options: options,
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
+        label: "Name",
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_Button["default"], {
+        label: "Accept",
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
+        label: "Older age",
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement(_Select["default"], {
+        label: "Country",
+        options: options,
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+        label: "Country",
+        options: options,
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
+        label: "Name",
+        tabIndex: -1
+      }), /*#__PURE__*/_react["default"].createElement(_Textarea["default"], {
+        label: "Description"
+      }))),
+      getAllByRole = _render18.getAllByRole;
     var textarea = getAllByRole("textbox")[2];
     expect(document.activeElement).toEqual(textarea);
   });
   test("Focus jumps from last element to the first", function () {
     var _render19 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement(_Checkbox["default"], {
-      label: "Accept",
-      disabled: true
-    }), /*#__PURE__*/_react["default"].createElement(_Textarea["default"], {
-      label: "Name"
-    }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
-      label: "Name",
-      options: options
-    }))),
-        getByRole = _render19.getByRole;
-
+        label: "Accept",
+        disabled: true
+      }), /*#__PURE__*/_react["default"].createElement(_Textarea["default"], {
+        label: "Name"
+      }), /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+        label: "Name",
+        options: options
+      }))),
+      getByRole = _render19.getByRole;
     var closeAction = getByRole("button");
     var textarea = getByRole("textbox");
     expect(document.activeElement).toEqual(textarea);
-
     _userEvent["default"].tab();
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(closeAction);
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(textarea);
   });
   test("'display: none;', 'visibility: hidden;' and 'type = 'hidden'' elements are never autofocused", function () {
     var _render20 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_Dialog["default"], null, /*#__PURE__*/_react["default"].createElement("input", {
-      label: "Name",
-      style: {
-        display: "none"
-      }
-    }), /*#__PURE__*/_react["default"].createElement("input", {
-      label: "Name",
-      style: {
-        visibility: "hidden"
-      }
-    }), /*#__PURE__*/_react["default"].createElement("input", {
-      type: "hidden",
-      name: "example"
-    }))),
-        getByRole = _render20.getByRole;
-
+        label: "Name",
+        style: {
+          display: "none"
+        }
+      }), /*#__PURE__*/_react["default"].createElement("input", {
+        label: "Name",
+        style: {
+          visibility: "hidden"
+        }
+      }), /*#__PURE__*/_react["default"].createElement("input", {
+        type: "hidden",
+        name: "example"
+      }))),
+      getByRole = _render20.getByRole;
     var closeAction = getByRole("button");
     expect(document.activeElement).toEqual(closeAction);
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).toEqual(closeAction);
   });
   test("Focus gets trapped in the Dialog when there are not focusable elements inside until it is closed", function () {
     var _render21 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_react["default"].Fragment, null, /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
-      label: "Name"
-    }), /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
-      isCloseVisible: false
-    }, /*#__PURE__*/_react["default"].createElement("h2", null, "Policy agreement"), /*#__PURE__*/_react["default"].createElement("p", null, "Sample text.")), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
-      label: "Surname"
-    }))),
-        getAllByRole = _render21.getAllByRole;
-
+        label: "Name"
+      }), /*#__PURE__*/_react["default"].createElement(_Dialog["default"], {
+        isCloseVisible: false
+      }, /*#__PURE__*/_react["default"].createElement("h2", null, "Policy agreement"), /*#__PURE__*/_react["default"].createElement("p", null, "Sample text.")), /*#__PURE__*/_react["default"].createElement(_TextInput["default"], {
+        label: "Surname"
+      }))),
+      getAllByRole = _render21.getAllByRole;
     var inputs = getAllByRole("textbox");
     var dialog = getAllByRole("dialog")[0];
-
     _userEvent["default"].tab();
-
     _userEvent["default"].tab();
-
     expect(document.activeElement).not.toEqual(inputs[1]);
-
     _react2.fireEvent.keyDown(dialog, {
       key: "Tab",
       shiftKey: true
     });
-
     _react2.fireEvent.keyDown(dialog, {
       key: "Tab",
       shiftKey: true
     });
-
     expect(document.activeElement).not.toEqual(inputs[0]);
   });
 });

package/dialog/types.d.ts

@@ -1,31 +1,36 @@
 /// <reference types="react" />
-declare type Props = {
+type Props = {
     /**
-     * If true, the close 'x' button will be visible.
+     * If true, the close button will be visible.
      */
     isCloseVisible?: boolean;
     /**
-     * This function will be called when the user clicks the close 'x' button.
-     * The responsibility of hiding the modal lies with the user.
+     * This function will be called when the user clicks the close button.
+     * The responsibility of hiding the dialog lies with the user.
      */
     onCloseClick?: () => void;
+    /**
+     * This function will be called when the user clicks on the background of the modal.
+     * The responsibility of hiding the dialog lies with the user.
+     */
+    onBackgroundClick?: () => void;
     /**
      * If true, the dialog will be displayed over a darker background that covers the content behind.
      */
     overlay?: boolean;
     /**
-     * This function will be called when the user clicks background of the modal.
-     * The responsibility of hiding the modal lies with the user.
+     * Area within the dialog that can be used to render custom content.
+     * We strongly encourage users to not change the
+     * tabindex of the inner components or elements. This
+     * can lead to unpredictable behaviour for keyboard users, affecting
+     * the order of focus and focus locking within the dialog.
      */
-    onBackgroundClick?: () => void;
+    children: React.ReactNode;
     /**
-     * Value of the tabindex given to the close 'x' button.
+     * Value of the tabindex applied to the close button.
+     * Note that values greater than 0 are strongly discouraged. It can
+     * lead to unexpected behaviours with the focus within the dialog.
      */
     tabIndex?: number;
-    /**
-     * The area inside the dialog. This area can be used to render
-     * custom content.
-     */
-    children: React.ReactNode;
 };
 export default Props;