@app-studio/components
Toast
Displays temporary, dismissible messages to inform users about actions, status, or events.
View component sourceImport
ts
import { Toast } from '@app-studio/components';New to the library? Complete installation and provider setup first.
Interactive examples
Try the component, then open Code to copy the complete example.
import React from 'react';
import { Toast } from '@app-studio/components';
import { Button } from '@app-studio/components';
import { Horizontal } from 'app-studio';
export function ToastExample() {
return (
<>
<Horizontal gap={12} flexWrap="wrap">
<Button
onClick={() =>
Toast.success('Project saved', 'Your changes are ready.')
}
>
Show success
</Button>
<Button
variant="outline"
onClick={() => Toast.error('Try again', 'This is an example error.')}
>
Show error
</Button>
<Button variant="ghost" onClick={() => Toast.removeAll()}>
Dismiss all
</Button>
</Horizontal>
<Toast.Container />
</>
);
}Props
Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
id | string | — | See the type and source declaration for this property.Source |
variant Required | "error" | "info" | "success" | "warning""error""info""success""warning" | — | Visual treatment of the component.Source |
title Required | string | — | Main title displayed by the component.Source |
description | string | — | Secondary text describing the control or its current state.Source |
onClose Required | () => void | — | Called when the user requests dismissal.Source |
isClosable | boolean | — | See the type and source declaration for this property.Source |
action | (() => void) | — | See the type and source declaration for this property.Source |
actionText | string | — | See the type and source declaration for this property.Source |
showIcon | boolean | — | See the type and source declaration for this property.Source |
theme | ThemesType | — | See the type and source declaration for this property.Source |
views | ToastStyles | — | Style overrides for the named internal parts.Source |
duration | number | — | See the type and source declaration for this property.Source |
render | ((props: { id: string; onClose: () => void; }) => React.ReactNode) | — | See the type and source declaration for this property.Source |
icon | View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactNode> | null | undefined> | null | — | Icon rendered alongside the content.Source |
isVisible | boolean | — | See the type and source declaration for this property.Source |
Common inherited styling props (7)
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
onClick | any | — | Called when the user activates the component. |
media | Record<string, CssProps> | — | See the type and source declaration for this property. |
as | keyof JSX.IntrinsicElements"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view" | — | See the type and source declaration for this property. |
themeMode | "light" | "dark""light""dark" | — | See the type and source declaration for this property. |
_hover | string | CssProps | — | See the type and source declaration for this property. |
_active | string | CssProps | — | See the type and source declaration for this property. |
_focus | string | CssProps | — | See the type and source declaration for this property. |
Toast.Container
Scroll horizontally to see every column.
| Prop | Type | Default | Description |
|---|---|---|---|
position | ToastPosition | — | Position of the element or notification.Source |
gap | number | — | See the type and source declaration for this property.Source |
limit | number | — | See the type and source declaration for this property.Source |
containerStyle | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").CSSProperties | — | See the type and source declaration for this property.Source |
For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.
Usage guidance
- Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
- For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
- These previews run in the browser. Check React Native setup for platform requirements and differences.