Skip to main content

InterfaceNotificationToastHelpers

Admin Docs

Interface: InterfaceNotificationToastHelpers

Defined in: src/types/shared-components/NotificationToast/interface.ts:64

Reusable helper API exposed by NotificationToast.

Properties​

dismiss()​

dismiss: () => void

Defined in: src/types/shared-components/NotificationToast/interface.ts:88

Dismiss all active toasts.

Returns​

void

error()​

error: (message, options?) => Id

Defined in: src/types/shared-components/NotificationToast/interface.ts:73

Show an error toast.

Parameters​

message​

NotificationToastMessage

options?​

ToastOptions

Returns​

Id

info()​

info: (message, options?) => Id

Defined in: src/types/shared-components/NotificationToast/interface.ts:83

Show an info toast.

Parameters​

message​

NotificationToastMessage

options?​

ToastOptions

Returns​

Id

promise()​

promise: <T>(promisifiedFunction, messages, options?) => Promise<T>

Defined in: src/types/shared-components/NotificationToast/interface.ts:93

Show a promise toast with pending, success, and error states.

Type Parameters​

T​

T = void

Parameters​

promisifiedFunction​

PromiseFunction<T>

messages​

InterfacePromiseMessages

options?​

ToastOptions

Returns​

Promise<T>

success()​

success: (message, options?) => Id

Defined in: src/types/shared-components/NotificationToast/interface.ts:68

Show a success toast.

Parameters​

message​

NotificationToastMessage

options?​

ToastOptions

Returns​

Id

warning()​

warning: (message, options?) => Id

Defined in: src/types/shared-components/NotificationToast/interface.ts:78

Show a warning toast.

Parameters​

message​

NotificationToastMessage

options?​

ToastOptions

Returns​

Id