Toast Dismiss

sudoischenny · sudoischenny · commit 791cff1e98d2 · 2024-02-27T16:02:40.000-05:00
Added the ability to allow or disallow toasts to be dismissed.
diff --git a/client/packages/lowcoder/src/comps/hooks/toastComp.ts b/client/packages/lowcoder/src/comps/hooks/toastComp.ts
@@ -19,17 +19,19 @@ const showNotification = (
   const text = params?.[0] as string;
   const options = params?.[1] as JSONObject;
 
-  const { message , duration, id, placement } = options;
+  const { message , duration, id, placement, dismissible } = options;
+
+  const closeIcon: boolean | undefined = dismissible === true ? undefined : (dismissible === false ? false : undefined);
 
-  // Convert duration to a number or null, if it's not a valid number, default to null
   const durationNumberOrNull: number | null = typeof duration === 'number' ? duration : null;
 
   const notificationArgs: ArgsProps = {
     message: text,
     description: message as React.ReactNode,
     duration: durationNumberOrNull ?? 3,
-    key: id as React.Key, // Ensure id is a valid React.Key
-    placement: placement as NotificationPlacement ?? "bottomRight", // Ensure placement is a valid NotificationPlacement or undefined
+    key: id as React.Key,
+    placement: placement as NotificationPlacement ?? "bottomRight",
+    closeIcon: closeIcon as boolean,
   };
 
   // Use notificationArgs to trigger the notification
diff --git a/docs/build-apps/write-javascript/built-in-javascript-functions.md b/docs/build-apps/write-javascript/built-in-javascript-functions.md
@@ -132,15 +132,15 @@ The id field can be used to update previous toasts. Or used to destroy the previ
 Destroy function used without an id will remove all toast.
 
 ```javascript
-// toast.open( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight" } )
+// toast.open( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight", dismissible?: boolean = true } )
 toast.open("This Is a Notification", {message: "I do not go away automatically.", duration: 0})
-// toast.info( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight" } )
+// toast.info( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight", dismissible?: boolean = true } )
 toast.info("Order #1519", {message: "Shipped out on Tuesday, Jan 3rd.", duration: 5})
-// toast.success( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight" } )
+// toast.success( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight", dismissible?: boolean = true } )
 toast.success("Query runs successfully", { duration: 10 })
-// toast.warn( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight" } )
+// toast.warn( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight", dismissible?: boolean = true } )
 toast.warn("Duplicate Action", {message: "The email was previously sent on Jan 3rd. Click the button again to send.", duration: 5})
-// toast.error( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight" } )
+// toast.error( title: string, options?: { message?: string, duration?: number = 3, id?: string, placement?: "top" | "topLeft" | "topRight" | "bottom" | "bottomRight", "bottomRight" = "bottomRight", dismissible?: boolean = true } )
 toast.error("Your credentials were invalid", {message: "You have 5 tries left", duration: 5})
 //toast.destroy(id?: string)
 toast.destroy()
