XiodUI
HomeDocs
OverviewComponentsStyling & CustomizationChangelog

Components

  • Accordion
  • Agent Steps
  • Alert
  • Alert Dialog
  • Aspect Ratio
  • Autocomplete
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Button Group
  • Button Split
  • Calendar
  • Card
  • Carousel
  • Checkbox
  • Circular Progress
  • Collapsible
  • Color Picker
  • Combobox
  • Command
  • Context Menu
  • Copy To Clipboard
  • Corner Badge
  • Dashboard Grid
  • Date Picker
  • Dialog
  • Dot Matrix
  • Draggable
    Updated
  • Drawer
  • Empty
  • Field
  • Fieldset
  • File Upload
    Updated
  • Form
  • Frame
  • Gauge
  • Grid
  • Group
  • Input
  • Input Group
  • Input OTP
  • Input Payment
  • Input Phone
    Updated
  • Input Sensitive
  • Kbd
  • Kinetic Click
  • Label
  • List Box
    Updated
  • Loader
  • Marker
  • Menu
  • Menubar
  • Message
  • Meter
  • Morphic Toast
  • Navigation Menu
  • Number Field
  • Option Picker
  • Orb
  • Pagination
  • Popover
  • Preview Card
    Updated
  • Progress
  • Radio
  • Resizable
  • Ruler Picker
  • Scroll Area
  • Scroll Bar
  • Select
  • Separator
  • Sidebar
  • Skeleton
  • Slider
  • Sortable
  • Switch
  • Table
  • Tabs
  • Text
  • Textarea
  • Timeline
  • Toast
  • Toggle
  • Toggle Group
  • Toolbar
  • Tooltip
  • Waveform
  • Wheel Picker

Loading...

Preview Skeleton

Installation Skeleton

Usage Skeleton

API Reference Skeleton

Sponsors

Support the development of XiodUI and help us build the best component library on Earth.

+++
Sponsor on GitHub

Toast

Previous: TimelineNext: Toggle

A short message that appears briefly without interrupting the user.

Preview

Loading Preview...

Installation

bun add xiod-ui

Usage

Imports

1import { AnchoredToastProvider, ToastProvider } from "xiod-ui/toast";

API Reference

Detailed documentation of properties and options.

AnchoredToastProvider

PropTypeDefaultDescription
children
ReactNode
–

The content of the component.

classNames
ToastClassNames
–

Extra classes for the parts of every toast this provider shows.

closeButton
boolean
false

Whether every toast shows a close button. A toast's own

ToastProvider

PropTypeDefaultDescription
children
ReactNode
–

The content of the component.

classNames
ToastClassNames
–

Extra classes for the parts of every toast this provider shows.

closeButton
TimelineToggle
closeButton
overrides this.
closeIcon
ReactNode
–

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

limit
number
3

The maximum number of toasts that can be displayed at once. When the limit is exceeded, the oldest toasts are marked as limited (via the data-limited attribute) rather than removed, so they can be hidden or animated out.

timeout
number
5000

The default amount of time (in ms) before a toast is auto dismissed. A value of 0 will prevent the toast from being dismissed automatically.

toastManager
ToastManager<any>
–

A global manager for toasts to use outside of a React component.

boolean
false

Whether every toast shows a close button. A toast's own closeButton overrides this.

closeIcon
ReactNode
–

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

limit
number
3

The maximum number of toasts that can be displayed at once. When the limit is exceeded, the oldest toasts are marked as limited (via the data-limited attribute) rather than removed, so they can be hidden or animated out.

position
"bottom-left"|"bottom-right"|"top-left"|"top-right"|"top-center"|"bottom-center"
bottom-right

The corner or edge of the screen where toasts appear.

timeout
number
5000

The default amount of time (in ms) before a toast is auto dismissed. A value of 0 will prevent the toast from being dismissed automatically.

toastManager
ToastManager<any>
–

A global manager for toasts to use outside of a React component.