Skip to content

toast

FieldValue
Prefixtoast
Namespace constantToastNamespace
Subjects constantToastSubjects
Kindbus
Schema recordToastSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/toast/namespace.ts
KeyWireTypeSchema
dismisstoast.dismisseventschemas.ts
dismissedtoast.dismissedeventschemas.ts
interactedtoast.interactedeventschemas.ts
showtoast.showeventschemas.ts

Dismiss a toast notification programmatically. Event: Fire-and-forget broadcast to close a specific toast.

Subject: toast.dismiss Type: Event

FieldTypeRequired
toastIdstringyes

Toast was dismissed (either by user or timeout). Event: Fired when a toast is closed/dismissed.

Subject: toast.dismissed Type: Event

FieldTypeRequired
timestampnumberyes
toastIdstringyes

User interacted with a toast action button. Event: Fired when user clicks an action button on a toast.

Subject: toast.interacted Type: Event

FieldTypeRequired
actionIdstringyes
timestampnumberyes
toastIdstringyes

Show a toast notification. Event: Fire-and-forget broadcast to display a toast.

Subject: toast.show Type: Event

FieldTypeRequired
actions{ id: string; label: string; variant?: "default" | "destructive" | "outline" | undefined; }[] | undefinedno
durationMsnumber | null | undefinedno
level"success" | "error" | "info" | "warning"yes
messagestringyes
titlestring | undefinedno
toastIdstring | undefinedno

Auto-generated by yarn docs:bus. Do not edit manually.