displayMessage MethodStatic

Display a message. Works only with Sticky and Toast message types.

displayMessage(message: NotifyMessageDetailsType, options?: ToastOptions, settings?: [settings]): undefined | { close: () => void }

@returns Object with reference to the message (i.e. to close it programmatically) if it was displayed.

Parameter Type Description
message NotifyMessageDetailsType Details about the message to display.
options ToastOptions Optionally override individual toast parameters.
settings [settings] Optionally override all toasts settings (i.e. placement or order).

Returns - undefined | { close: () => void }

Object with reference to the message (i.e. to close it programmatically) if it was displayed.

Defined in

Last Updated: 21 November, 2024