matrix/matrix-react-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-react-sdk.git synced 2025-11-11 20:22:36 +03:00
Code Activity

Add jsdoc explaining ordering behaviour

Browse Source
This commit is contained in:
David Baker
2020-04-29 15:10:23 +01:00
parent e9214f7d13
commit 58c0cfe315
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/stores/ToastStore.js
View File

@@ -39,6 +39,15 @@ export default class ToastStore extends EventEmitter {
this._toasts = []; this._toasts = [];
} }
/**
* Add or replace a toast
* If a toast with the same toastKey already exists, the given toast will replace it
* Toasts are always added underneath any toasts of the same priority, so existing
* toasts stay at the top unless a higher priority one arrives (better to not change the
* toast unless necessary).
*
* @param {boject} newToast The new toast
*/
addOrReplaceToast(newToast) { addOrReplaceToast(newToast) {
if (newToast.priority === undefined) newToast.priority = ToastStore.PRIORITY_DEFAULT; if (newToast.priority === undefined) newToast.priority = ToastStore.PRIORITY_DEFAULT;