toast
| Field | Value |
|---|---|
| Prefix | toast |
| Namespace constant | ToastNamespace |
| Subjects constant | ToastSubjects |
| Kind | bus |
| Schema record | ToastSchemas |
| Tier | framework |
| Package | @makaio/contracts |
| Defined in | packages/contracts/src/toast/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
dismiss | toast.dismiss | event | schemas.ts |
dismissed | toast.dismissed | event | schemas.ts |
interacted | toast.interacted | event | schemas.ts |
show | toast.show | event | schemas.ts |
Subject Details
Section titled “Subject Details”toast.dismiss (event)
Section titled “toast.dismiss (event)”Dismiss a toast notification programmatically. Event: Fire-and-forget broadcast to close a specific toast.
Subject: toast.dismiss
Type: Event
| Field | Type | Required |
|---|---|---|
toastId | string | yes |
toast.dismissed (event)
Section titled “toast.dismissed (event)”Toast was dismissed (either by user or timeout). Event: Fired when a toast is closed/dismissed.
Subject: toast.dismissed
Type: Event
| Field | Type | Required |
|---|---|---|
timestamp | number | yes |
toastId | string | yes |
toast.interacted (event)
Section titled “toast.interacted (event)”User interacted with a toast action button. Event: Fired when user clicks an action button on a toast.
Subject: toast.interacted
Type: Event
| Field | Type | Required |
|---|---|---|
actionId | string | yes |
timestamp | number | yes |
toastId | string | yes |
toast.show (event)
Section titled “toast.show (event)”Show a toast notification. Event: Fire-and-forget broadcast to display a toast.
Subject: toast.show
Type: Event
| Field | Type | Required |
|---|---|---|
actions | { id: string; label: string; variant?: "default" | "destructive" | "outline" | undefined; }[] | undefined | no |
durationMs | number | null | undefined | no |
level | "success" | "error" | "info" | "warning" | yes |
message | string | yes |
title | string | undefined | no |
toastId | string | undefined | no |
Auto-generated by yarn docs:bus. Do not edit manually.