Add jsdoc explaining ordering behaviour
This commit is contained in:
parent
1291a63b98
commit
325e1f9c4e
1 changed files with 9 additions and 0 deletions
|
@ -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;
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue