Interface: ToastNotificationApi

ToastNotificationApi.ToastNotificationApi

Description

Allows developers to display toast notifications in the application

Properties

Properties

createAndShowErrorToast

createAndShowErrorToast: (message: undefined | string) => void

Type declaration

▸ (message): void

Parameters
Name Type Description
message undefined | string Optional message string. If a message is not supplied, toast will be displayed with a generic error message
Returns

void

Description

Creates and shows a toast notification styled as an error notification with an optional error message


createAndShowInformationToast

createAndShowInformationToast: (message: string) => void

Type declaration

▸ (message): void

Parameters
Name Type Description
message string The message to display in toast
Returns

void

Description

Creates and shows a toast notification styled as an informational notification with the supplied message text


createAndShowSuccessToast

createAndShowSuccessToast: (message: string) => void

Type declaration

▸ (message): void

Parameters
Name Type Description
message string The message to display in toast
Returns

void

Description

Creates and shows a toast notification styled as a success notification with the supplied message text


createAndShowWarningToast

createAndShowWarningToast: (message: string) => void

Type declaration

▸ (message): void

Parameters
Name Type Description
message string The message to display in toast
Returns

void

Description

Creates and shows a toast notification styled as a warning notification with the supplied message text


createToast

createToast: (options: ToastNotificationOptions) => ToastNotification

Type declaration

▸ (options): ToastNotification

Parameters
Name Type Description
options ToastNotificationOptions The options to configure the toast notification
Returns

ToastNotification

A ToastNotification object based on the supplied options

Description

Creates the toast notification with the specified options

See

Toastify API


hideToast

hideToast: (toast: ToastNotification) => void

Type declaration

▸ (toast): void

Description

Hides the previously created toast notification, can also be called directly on the object returned from createToast

Parameters
Name Type Description
toast ToastNotification The previously created toast notification to hide
Returns

void


showToast

showToast: (toast: ToastNotification) => void

Type declaration

▸ (toast): void

Description

Shows the previously created toast notification, can also be called directly on the object returned from createToast

Parameters
Name Type Description
toast ToastNotification The previously created toast notification to show
Returns

void