ToastApi
ToastApi =
object
Defined in: packages/ui/src/types.ts:1025
Imperative API returned by useToast() for showing notifications.
Provides a show() method for full control and convenience methods for each
ToastType. Also used internally by useActionToast() to auto-display
notifications when @cfast/actions operations complete.
- ToastOptions for the full options object.
- ToastSlotProps for the provider slot that enables toast rendering.
Properties
Section titled “Properties”error()
Section titled “error()”error: (
message,description?) =>void
Defined in: packages/ui/src/types.ts:1031
Show an error toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
description?
Section titled “description?”string
Returns
Section titled “Returns”void
info()
Section titled “info()”info: (
message,description?) =>void
Defined in: packages/ui/src/types.ts:1033
Show an informational toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
description?
Section titled “description?”string
Returns
Section titled “Returns”void
show()
Section titled “show()”show: (
options) =>void
Defined in: packages/ui/src/types.ts:1027
Show a toast with full options control.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”void
success()
Section titled “success()”success: (
message,description?) =>void
Defined in: packages/ui/src/types.ts:1029
Show a success toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
description?
Section titled “description?”string
Returns
Section titled “Returns”void
warning()
Section titled “warning()”warning: (
message,description?) =>void
Defined in: packages/ui/src/types.ts:1035
Show a warning toast.
Parameters
Section titled “Parameters”message
Section titled “message”string
description?
Section titled “description?”string
Returns
Section titled “Returns”void