@homebound/beam 2.71.4 → 2.71.5

package/dist/components/Modal/OpenModal.d.ts

@@ -1,8 +1,16 @@
 import { ModalProps } from "./Modal";
+export interface OpenModalProps {
+    /** The custom modal content to show. */
+    children: JSX.Element;
+    /** The size to use. */
+    size?: ModalProps["size"];
+    /** Whether to force the modal to stay open. This is useful for stories where ruler/tape extensions cause the modal to close. */
+    keepOpen?: boolean;
+}
 /**
- * A component for testing open modals in unit tests.
+ * A component for testing open modals in stories and unit tests.
  *
- * Current, calling `render(<ModalComponent />)` in a test currently doesn't work, because
+ * Currently, calling `render(<ModalComponent />)` in a test currently doesn't work, because
  * nothing has called `useModal` to get the header & footer mounted into the DOM.
  *
  * So instead tests can call:
@@ -18,7 +26,4 @@ import { ModalProps } from "./Modal";
  * And `OpenModal` will do a boilerplate `openModal` call, so that the content
  * shows up in the DOM as expected.
  */
-export declare function OpenModal(props: {
-    children: JSX.Element;
-    size?: ModalProps["size"];
-}): JSX.Element;
+export declare function OpenModal(props: OpenModalProps): JSX.Element;

package/dist/components/Modal/OpenModal.js

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenModal = void 0;
 const jsx_runtime_1 = require("@emotion/react/jsx-runtime");
 const react_1 = require("react");
+const Modal_1 = require("./Modal");
 const useModal_1 = require("./useModal");
 /**
- * A component for testing open modals in unit tests.
+ * A component for testing open modals in stories and unit tests.
  *
- * Current, calling `render(<ModalComponent />)` in a test currently doesn't work, because
+ * Currently, calling `render(<ModalComponent />)` in a test currently doesn't work, because
  * nothing has called `useModal` to get the header & footer mounted into the DOM.
  *
  * So instead tests can call:
@@ -25,8 +26,17 @@ const useModal_1 = require("./useModal");
  */
 function OpenModal(props) {
     const { openModal } = (0, useModal_1.useModal)();
-    const { size, children } = props;
-    (0, react_1.useEffect)(() => openModal({ size, content: children }), [openModal, size, children]);
-    return (0, jsx_runtime_1.jsx)("div", { children: "dummy content" }, void 0);
+    const { size, children, keepOpen } = props;
+    (0, react_1.useEffect)(() => {
+        if (!keepOpen) {
+            openModal({ size, content: children });
+        }
+    }, [keepOpen, openModal, size, children]);
+    if (keepOpen) {
+        return (0, jsx_runtime_1.jsx)(Modal_1.Modal, { size: size, content: children }, void 0);
+    }
+    else {
+        return (0, jsx_runtime_1.jsx)("div", { children: "dummy content" }, void 0);
+    }
 }
 exports.OpenModal = OpenModal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebound/beam",
-  "version": "2.71.4",
+  "version": "2.71.5",
   "author": "Homebound",
   "license": "MIT",
   "main": "dist/index.js",