toast: add remove method to clear a single message (#4101)

Co-authored-by: Clément Bernard <[email protected]>
primefaces · Oct 5, 2023 · cee9688 · cee9688
1 parent 4bcb9bd
commit cee9688
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/components/lib/toast/Toast.vue b/components/lib/toast/Toast.vue
@@ -43,6 +43,7 @@ export default {
     styleElement: null,
     mounted() {
         ToastEventBus.on('add', this.onAdd);
+        ToastEventBus.on('remove', this.onRemove);
         ToastEventBus.on('remove-group', this.onRemoveGroup);
         ToastEventBus.on('remove-all-groups', this.onRemoveAllGroups);
 
@@ -58,6 +59,7 @@ export default {
         }
 
         ToastEventBus.off('add', this.onAdd);
+        ToastEventBus.off('remove', this.onRemove);
         ToastEventBus.off('remove-group', this.onRemoveGroup);
         ToastEventBus.off('remove-all-groups', this.onRemoveAllGroups);
     },
@@ -87,6 +89,9 @@ export default {
                 this.add(message);
             }
         },
+        onRemove(message) {
+            this.remove({ message, type: 'close' });
+        },
         onRemoveGroup(group) {
             if (this.group === group) {
                 this.messages = [];

diff --git a/components/lib/toastservice/ToastService.d.ts b/components/lib/toastservice/ToastService.d.ts
@@ -23,6 +23,11 @@ export interface ToastServiceMethods {
      * @param {ToastMessageOptions} message - Message instance.
      */
     add(message: ToastMessageOptions): void;
+    /**
+     * Clears the message.
+     * @param {ToastMessageOptions} message - Message instance.
+     */
+    remove(message: ToastMessageOptions): void;
     /**
      * Clears the messages that belongs to the group.
      * @param {string} group - Name of the message group.

diff --git a/components/lib/toastservice/ToastService.js b/components/lib/toastservice/ToastService.js
@@ -7,6 +7,9 @@ export default {
             add: (message) => {
                 ToastEventBus.emit('add', message);
             },
+            remove: (message) => {
+                ToastEventBus.emit('remove', message);
+            },
             removeGroup: (group) => {
                 ToastEventBus.emit('remove-group', group);
             },

diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
@@ -49887,6 +49887,19 @@
                             "returnType": "void",
                             "description": "Displays the message in a suitable Toast component."
                         },
+                        {
+                            "name": "remove",
+                            "parameters": [
+                                {
+                                    "name": "message",
+                                    "optional": false,
+                                    "type": "ToastMessageOptions",
+                                    "description": "Message instance."
+                                }
+                            ],
+                            "returnType": "void",
+                            "description": "Clears the message."
+                        },
                         {
                             "name": "removeGroup",
                             "parameters": [