Toast

Installation

Copy editable source into an initialized application:

pnpm dlx @simurgh-ui/cli add toast

For package consumption, import from the component subpath and load its optional recipe CSS:

React

import {
  ToastProvider,
  useToast,
  ToastViewport,
  ToastMessage,
} from '@simurgh-ui/react/toast';
import '@simurgh-ui/styles/toast.css';

Vue

import {
  ToastProvider,
  useToast,
  ToastViewport,
  ToastMessage,
} from '@simurgh-ui/vue/toast';
import '@simurgh-ui/styles/toast.css';

Angular

import {
  ToastViewportComponent,
  ToastMessage,
} from '@simurgh-ui/angular/toast';
import '@simurgh-ui/styles/toast.css';

Omit the component stylesheet for fully headless styling. CLI-copied components use the local path written to simurgh.json and the copied application styles instead of these package imports.

Purpose

ToastProvider owns the queue; the viewport renders polite status announcements. Durations may be disabled for persistent messages, and every toast has a labelled dismiss action.

Default presentation: styled

The optional component stylesheet provides a complete default recipe, including visual hierarchy and interaction states. Consumers can override semantic tokens or omit the recipe.

Basic usage

Live component Toast ◆

Save changes

Anatomy

The public component parts are listed in API surface below. Use only the parts needed by the example; compound components depend on their documented parent/child nesting.

State model

This component exposes no public controlled/uncontrolled state pair. Configure it through the props, events, native attributes, or parent-owned state documented in the API tables.

Keep messages concise. Use a dialog or inline error when the user must respond before continuing.

Examples

React

const { toast } = useToast();
toast({ title: 'Saved', description: 'Your changes are live.' });
// Render <ToastViewport /> inside <ToastProvider>.

Vue

const { toast } = useToast();
toast({ title: 'Saved', description: 'Your changes are live.' });
// Render ToastViewport inside ToastProvider.

Angular

@ViewChild(ToastViewportComponent) toasts!: ToastViewportComponent;
this.toasts.toast({ title: 'Saved', description: 'Your changes are live.' });

Accessibility

Preserve the documented composition and accessible names when wrapping or restyling this component. See accessibility and RTL guidance for keyboard, focus, labeling, and directionality requirements.

API surface

• React exports: ToastProvider, useToast, ToastViewport, ToastMessage
• Vue exports: ToastProvider, useToast, ToastViewport, ToastMessage
• Angular exports: ToastViewportComponent, ToastMessage

Import these public symbols from the component subpath shown in Installation. Framework-specific props, events, slots, directives, methods, defaults, and native-attribute behavior belong in the API tables on this page; use the linked source only to verify the current implementation.

React API reference

React

An inherited-attributes entry means the component accepts the complete named React native interface, including its event handlers and ARIA and data attributes. Remaining attributes are forwarded to the rendered element unless the component behavior described on this page overrides them.

ToastProvider

Complete props type: { children?: ReactNode; }.

Prop	Type	Default / requirement
children	ReactNode	undefined

useToast

This component has no public props.

ToastViewport

Inherited attributes: HTMLAttributes<HTMLDivElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined

ToastMessage

Exported type: { id: string; title: ReactNode; description?: ReactNode; duration?: number; }.

Vue API reference

Vue

Boolean props without explicit defaults use Vue’s false default. Undeclared attributes follow the fallthrough behavior stated for each component.

ToastProvider

Vue attribute fallthrough is enabled for the rendered root.

No declared props.

No emitted events.

Slots: default.

Exposed methods: none.

useToast

Exported type: any.

ToastViewport

Vue attribute fallthrough is enabled for the rendered root.

No declared props.

No emitted events.

Slots: none.

Exposed methods: none.

ToastMessage

Exported type: { id: string; title: string; description?: string; }.

Angular API reference

Angular

Inputs and outputs use their public template names. Public methods are callable through a template reference or ViewChild. Native attributes apply to the documented template root or directive host; they are not automatically forwarded through component hosts.

ToastViewportComponent

Component selector: simurgh-toast-viewport. The template’s first native element is div.

No inputs.

No outputs.

Content projection: none.

Public method
toast(message: Omit<ToastMessage, "id">, duration?: number): string
dismiss(id: string): void

ToastMessage

Exported type: { id: string; title: string; description?: string; }.

Composition contract

Follow the framework example as a structural contract. Root components own shared state; parts that consume that state must stay under the root (or be attached to projected descendants in Angular). Parts described as conditional are optional until their corresponding interaction or semantic region is used. Do not render a state-consuming part by itself.

Framework	Required parent/child relationship	Conditional parts	Supporting types
React	Render ToastProvider as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	useToast, ToastViewport are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	ToastMessage.
Vue	Render ToastProvider as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	useToast, ToastViewport are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	ToastMessage.
Angular	ToastViewportComponent is standalone and required when using this component.	Content is optional unless the API requires a label or value.	ToastMessage.

Accessible names, descriptions, and form labels remain required whenever the component’s purpose cannot otherwise be determined, even when the corresponding visual part is optional.

Framework parity and differences

The adapters target the same user-visible behavior and accessibility contract. Their public shapes follow each framework’s conventions and are not expected to be symbol-for-symbol identical.

Concern	Contract
Public composition	React exports 4 parts, Vue 4, and Angular 2. These are intentional composition differences; use each framework’s example rather than translating symbol-for-symbol.
State and change events	No controlled state contract; use native attributes, inputs, or events documented above.
Children and content	React uses children; Vue uses the slots listed above; Angular uses the documented content projection selectors.
Native attributes	React forwards the named native interface; Vue follows the stated fallthrough rule; Angular attributes apply to the component host unless an input, directive, or documented native root consumes them.
Imperative access	React has no forwarded ref; Vue exposes no methods; Angular exposes the listed class methods through a template reference or ViewChild.

These differences are intentional adapter design. Behavioral or accessibility differences not stated on this page are parity defects rather than supported variations.

Form integration

This component is not a form control and does not contribute a named value to FormData. Use it to structure or describe a form only when its purpose and accessibility guidance apply.

Supported states

The table distinguishes component behavior from application-owned presentation. “Not supported” means there is no public state contract for that adapter; do not invent one with an undocumented attribute. Keep status and error messages accessible when they are rendered outside the component.

State	React	Vue	Angular
Loading	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Empty	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Invalid	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Read-only	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Disabled	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Error	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.

Styling contract

Styling contract

The selectors below are used by the published component recipe or emitted consistently by an adapter. Treat these as the supported styling surface. Element order, anonymous wrappers, and undocumented descendants are implementation details and should not be targeted.

Surface	Stable hooks
Recipe classes	.simurgh-toast, .simurgh-toast-region
Stable DOM parts	No named data-slot parts are emitted; target the forwarded root class or attributes documented in the API.
Stable data attributes	No documented data-* hook.
ARIA/state selectors used by the recipe	No ARIA state selector is used by this recipe.
CSS custom properties consumed	--simurgh-duration

Prefer a semantic token override for theme-wide changes. Use the listed class or part selectors for a component-scoped override. When omitting recipe CSS, preserve state attributes and ARIA semantics even if your replacement styles use different selectors.

Customization

Load the optional component stylesheet for the default recipe, override semantic tokens for broad theme changes, or omit the recipe CSS for headless styling. See theming and styling hooks for import order, selectors, dark mode, RTL, and reduced-motion guidance.

Last verified on 2026-08-13 against Simurgh registry 0.1.1.

Related components

• Review the shared accessibility and RTL guidance and theming and styling hooks.
• Use the component chooser and component overview to compare related primitives.
• Inspect the registry manifest and framework source for React, Vue, or Angular.