Toast

Inline notification surface and fixed toast stack.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Toast } from "@tavojs/ui/toast";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/toast.

When to use

Use it when

Use `Toast` for transient notifications and `ToastStack` for fixed positioning

Choose something else when

Avoid Toast when using feedback components as primary page layout.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Toast example

TSXCreate: src/components/examples/ToastExample1.tsx

tsximport { createTavo } from "@tavojs/core";
import { Toast } from "@tavojs/ui/toast";
import { Button, ToastStack } from "@tavojs/ui";

type State = { visible: boolean };

export const ToastExample1 = createTavo<Record<string, never>, State>({
  model: () => ({ visible: false }),
  view: ({ state, model }) => (
    <>
      <Button onClick={() => model.set("visible", true)}>Show notification</Button>
      <ToastStack>
        {state.visible ? <Toast title="Saved" tone="success" onClose={() => model.set("visible", false)}>Changes saved in this demo.</Toast> : null}
      </ToastStack>
    </>
  )
});

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`title`	`Child`	—	Configures title for this component.
`tone`	`"info" \| "success" \| "warning" \| "danger"`	—	Configures tone for this component.
`action`	`Child`	—	Configures action for this component.
`onClose`	`() => void`	—	Configures onClose for this component.
`closeLabel`	`string`	—	Configures closeLabel for this component.

Complete TypeScript API

Import from @tavojs/ui/toast. Published exports: Toast, ToastProps, ToastStack, ToastTone.

`ToastProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Toast.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Toast.
`id`	`string`	No	Inherited id attribute accepted by Toast.
`role`	`string`	No	Inherited role attribute accepted by Toast.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Toast.
`title`	`string & Child`	No	Configures title for this component.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Toast.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Toast.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Toast.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Toast.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Toast.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Toast.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Toast.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Toast.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Toast.
`tone`	`ToastTone`	No	Configures tone for this component.
`action`	`Child`	No	Configures action for this component.
`onClose`	`() => void`	No	Configures onClose for this component.
`closeLabel`	`string`	No	Configures closeLabel for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Toast when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Uses `role="status"`. Manage focus intentionally for destructive or blocking notifications.

Uses `role="status"`. Manage focus intentionally for destructive or blocking notifications.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/toast`
Explicit CSS import	`@tavojs/ui/css/toast`
Preview	Interactive preview available on this page