Skip to main content

Toast

Toast is a notification component for brief messages, like confirming a saved change or offering to undo an action. It shows the notifications you send with useToast and queues them at six screen positions.

Import

import { ToastProvider } from '@vortexlabs/vortex';
import type { ToastProviderProps } from '@vortexlabs/vortex';

Allied components

Other links

ToastProvider props
PropTypeDefaultAttributes
children
React.ReactNode
No default value
options
object
No default value

useToast().show

ToastShowProps props
PropTypeDefaultAttributes
layout
union
inline
icon
union
No default value
startSlot
React.ReactNode
No default value
title
React.ReactNode
No default value
description
React.ReactNode
No default value
children
React.ReactNode
No default value
actionsSlot
React.ReactNode
No default value
tone
union
inverse
className
union
No default value
attributes
object
No default value
timeout
union
brief
position
union
bottom-end