@linzjs/windows 3.6.1 → 3.7.0

package/dist/LuiModalAsync/LuiModalAsyncContext.tsx

@@ -1,4 +1,15 @@
-import { ComponentProps, MutableRefObject, ReactElement, createContext } from "react";
+import { ComponentProps, MutableRefObject, ReactElement, createContext, createRef } from "react";
+
+export const openModalOnAllWindows = createRef<HTMLDivElement>();
+
+/**
+ * @param showOnAllWindows If true this modal will show on all windows opened from main window including main window.
+ * @param
+ */
+export interface ShowModalProps {
+  showOnAllWindows?: boolean;
+  polledCloseCondition?: () => boolean;
+}
 
 export type ComponentType = (props: any) => ReactElement<any, any>;
 
@@ -27,6 +38,7 @@ export interface LuiModalAsyncContextType {
     ownerRef: MutableRefObject<OR>,
     component: CT,
     args: Omit<ComponentProps<CT>, "resolve" | "close">,
+    showModalProps?: ShowModalProps,
   ) => PromiseWithResolve<RT>;
 }
 

package/dist/LuiModalAsync/LuiModalAsyncContextProvider.tsx

@@ -1,7 +1,12 @@
-import { ComponentType, LuiModalAsyncContext, PromiseWithResolve } from "./LuiModalAsyncContext";
+import {
+  ComponentType,
+  LuiModalAsyncContext,
+  openModalOnAllWindows,
+  PromiseWithResolve,
+  ShowModalProps,
+} from "./LuiModalAsyncContext";
 import { LuiModalAsyncInstanceContext } from "./LuiModalAsyncInstanceContext";
 import React, {
-  createRef,
   MutableRefObject,
   PropsWithChildren,
   ReactElement,
@@ -14,13 +19,12 @@ import { createPortal } from "react-dom";
 import { useInterval } from "usehooks-ts";
 import { v4 as makeUuid } from "uuid";
 
-export const openModalOnAllWindows = createRef<HTMLDivElement>();
-
 export interface LuiModalAsyncInstance {
   uuid: string;
   ownerRef: MutableRefObject<HTMLElement | null>;
   componentInstance: ReactElement;
   resolve: (result: any) => void;
+  showModalProps?: ShowModalProps;
 }
 
 /**
@@ -97,7 +101,12 @@ export const LuiModalAsyncContextProvider = ({ children }: PropsWithChildren<unk
    * @param args Arguments for react component.
    */
   const showModal = useCallback(
-    (ownerRef: MutableRefObject<HTMLElement | null>, Component: ComponentType, args: any): PromiseWithResolve<any> => {
+    (
+      ownerRef: MutableRefObject<HTMLElement | null>,
+      Component: ComponentType,
+      args: any,
+      showModalProps?: ShowModalProps,
+    ): PromiseWithResolve<any> => {
       const uuid = makeUuid();
       let extResolve: PromiseWithResolve<any>["resolve"];
       const promise = new Promise((resolve) => {
@@ -111,6 +120,7 @@ export const LuiModalAsyncContextProvider = ({ children }: PropsWithChildren<unk
               ownerRef,
               componentInstance: <Component {...args} resolve={resolve} close={() => resolve(undefined)} />,
               resolve,
+              showModalProps,
             },
           ]);
         } catch (e) {
@@ -154,6 +164,12 @@ export const LuiModalAsyncContextProvider = ({ children }: PropsWithChildren<unk
     newModals.length !== modals.length && setModals(newModals);
     // We could do this with window close listeners, but they are unreliable
     openWindowsRef.current = openWindowsRef.current.filter((w) => !w.closed);
+
+    newModals.forEach((modalInstance) => {
+      if (modalInstance.showModalProps?.polledCloseCondition?.()) {
+        modalInstance.resolve(undefined);
+      }
+    });
   }, 500);
 
   const portalOwners = (modalInstance: LuiModalAsyncInstance) =>

package/dist/LuiModalAsync/useLuiModalPrefab.tsx

@@ -12,6 +12,7 @@ import React, { PropsWithChildren, ReactElement, useCallback, useMemo, useState
 import { LuiButton, LuiCheckboxInput, LuiMiniSpinner } from "@linzjs/lui";
 import { LuiButtonProps } from "@linzjs/lui/dist/components/LuiButton/LuiButton";
 import { IconName } from "@linzjs/lui/dist/components/LuiIcon/LuiIcon";
+import { omit, pick } from "lodash-es";
 
 export type PrefabType = "success" | "info" | "warning" | "error" | "progress" | "blocked";
 
@@ -30,6 +31,7 @@ export interface useLuiModalPrefabProps<RT extends any = string> extends LuiModa
   onHelpClick?: () => void;
   buttons?: LuiModalAsyncPrefabButton<RT>[];
   dontShowAgainSessionKey?: string;
+  polledCloseCondition?: () => boolean;
 }
 
 export interface LuiModalAsyncPrefabProps<RT> extends useLuiModalPrefabProps<RT>, LuiModalAsyncCallback<RT> {
@@ -186,13 +188,20 @@ export const useLuiModalPrefab = () => {
         const split = props.children.split("\n");
         props.children = flatMap(split.map((part, i) => (i !== split.length - 1 ? [part, <br key={i} />] : part)));
       }
-      if (props.dontShowAgainSessionKey && LuiModalDontShowSessionCheck(props.dontShowAgainSessionKey)) {
+      if (
+        (props.dontShowAgainSessionKey && LuiModalDontShowSessionCheck(props.dontShowAgainSessionKey)) ||
+        (props.polledCloseCondition && props.polledCloseCondition())
+      ) {
         // Add resolve method to make the signature of showPrefabModal consistent
         const prom = Promise.resolve(undefined) as PromiseWithResolve<RT>;
         prom.resolve = (_val: RT | undefined) => {};
         return prom;
       }
-      return showModal(LuiModalPrefab, props, { showOnAllWindows: props.showOnAllWindows }) as PromiseWithResolve<RT>;
+      return showModal(
+        LuiModalPrefab,
+        omit(props, ["showOnAllWindows", "polledCloseCondition"]),
+        pick(props, ["showOnAllWindows", "polledCloseCondition"]),
+      ) as PromiseWithResolve<RT>;
     },
     [showModal],
   );

package/dist/LuiModalAsync/useShowAsyncModal.ts

@@ -1,10 +1,11 @@
-import { ComponentType, LuiModalAsyncContext, PromiseWithResolve } from "./LuiModalAsyncContext";
+import {
+  ComponentType,
+  LuiModalAsyncContext,
+  openModalOnAllWindows,
+  PromiseWithResolve,
+  ShowModalProps,
+} from "./LuiModalAsyncContext";
 import { ComponentProps, useCallback, useContext, useMemo, useRef } from "react";
-import { openModalOnAllWindows } from "./LuiModalAsyncContextProvider";
-
-export interface ShowModalProps {
-  showOnAllWindows?: boolean;
-}
 
 export const useShowAsyncModal = () => {
   const { showModal } = useContext(LuiModalAsyncContext);
@@ -17,7 +18,7 @@ export const useShowAsyncModal = () => {
       args: Omit<ComponentProps<CT>, "resolve" | "close">,
       props?: ShowModalProps,
     ): PromiseWithResolve<Parameters<ComponentProps<CT>["resolve"]>[0]> =>
-      showModal(props?.showOnAllWindows ? openModalOnAllWindows : modalOwnerRef, component, args),
+      showModal(props?.showOnAllWindows ? openModalOnAllWindows : modalOwnerRef, component, args, props),
     [showModal],
   );
 

package/dist/panel/OpenPanelButton.tsx

@@ -11,7 +11,7 @@ export const OpenPanelButton = ({ buttonText, component }: OpenPanelButtonProps)
   const { openPanel, openPanels } = useContext(PanelsContext);
 
   return (
-    <button onClick={() => openPanel(buttonText, component)}>
+    <button onClick={() => openPanel({ uniqueId: buttonText, componentFn: component })}>
       Show {buttonText} {openPanels.has(buttonText) ? "(Open)" : ""}
     </button>
   );

package/package.json

@@ -13,7 +13,7 @@
     "popout"
   ],
   "main": "./dist/index.ts",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "peerDependencies": {
     "@linzjs/lui": ">=21",
     "lodash-es": ">=4",