useToast
useToast():
object
Defined in: react/components/overlay/toast-host.tsx:170
Hook returning the imperative toast façade for use inside components.
Returns
Section titled “Returns”clear: () =>
void
Dismiss all toasts.
Returns
Section titled “Returns”void
dismiss
Section titled “dismiss”dismiss: (
id) =>void
Dismiss a toast by id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
error: (
message,opts?) =>number
Error toast (sticky by default).
Parameters
Section titled “Parameters”message
Section titled “message”string
Omit<ToastOptions, "message" | "level">
Returns
Section titled “Returns”number
generic
Section titled “generic”generic: (
message,opts?) =>number
Neutral toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
Omit<ToastOptions, "message" | "level">
Returns
Section titled “Returns”number
info: (
message,opts?) =>number
Info toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
Omit<ToastOptions, "message" | "level">
Returns
Section titled “Returns”number
show: (
opts) =>number
Raise a toast from full options; returns its id.
Parameters
Section titled “Parameters”ToastOptions
Returns
Section titled “Returns”number
success
Section titled “success”success: (
message,opts?) =>number
Success toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
Omit<ToastOptions, "message" | "level">
Returns
Section titled “Returns”number
warn: (
message,opts?) =>number
Warning toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
Omit<ToastOptions, "message" | "level">
Returns
Section titled “Returns”number