feat: prevent user from accidentally closing frame

Author: Deepak-Kharah

__test__/fieldModifierLocation/frame.test.ts

@@ -185,4 +185,22 @@ describe("FieldModifierLocationFrame", () => {
             expect(sendToParent).toHaveBeenLastCalledWith("closeModal");
         });
     });
+
+    describe("preventFrameClose", () => {
+        it("should not allow user from clicking background", async () => {
+            await frameInstance.setAllowAppClose(false);
+            expect(sendToParent).toHaveBeenCalledTimes(1);
+            expect(sendToParent).toHaveBeenLastCalledWith("setAllowAppClose", {
+                isAllowed: false,
+            });
+        });
+
+        it("should allow user from clicking background", async () => {
+            await frameInstance.setAllowAppClose(true);
+            expect(sendToParent).toHaveBeenCalledTimes(1);
+            expect(sendToParent).toHaveBeenLastCalledWith("setAllowAppClose", {
+                isAllowed: true,
+            });
+        });
+    });
 });

dist/index.js

@@ -23,6 +23,11 @@ declare class FieldModifierLocationFrame {
         height?: number;
         width?: number;
     }): Promise<void>;
+    /**
+     * Prevent user from accidently closing the app by clicking outside the frame
+     *  if the app is performing some active task.
+     */
+    setAllowAppClose(isAllowed: boolean): Promise<void>;
     /**
      * This method enables auto resizing of the extension height.
      * @return {FieldModifierLocationFrame}.

dist/index.js.map

@@ -89,6 +89,16 @@ class FieldModifierLocationFrame {
         }
     }
 
+    /**
+     * Prevent user from accidently closing the app by clicking outside the frame
+     *  if the app is performing some active task.
+     */
+    async setAllowAppClose(isAllowed: boolean) {
+        await this._connection.sendToParent("setAllowAppClose", {
+                    isAllowed,
+        });
+    }
+
     /**
      * This method enables auto resizing of the extension height.
      * @return {FieldModifierLocationFrame}.