Toast

children

ReactNode

Default: —

Your app, rendered inside the provider.

position

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

Default: "bottom-right"

Where the toast region renders.

maxToasts

number

Default: 12

Total toasts kept in the queue (visible + pending).

maxVisibleToasts

number

Default: 3

Toasts shown at once before stacking/queuing.

toastOffset

number

Default: 0

Extra offset from the viewport edge.

container

Element | DocumentFragment | null

Default: —

Custom portal mount target.

defaultDuration

number

Default: 6000

Auto-dismiss duration in ms, unless overridden per-toast or persistent.

toastProps

ToastOptions

Default: —

Default options applied to every toast from this provider.

motion

"auto" | "reduced" | "default"

Default: "auto"

Animation mode; "auto" respects prefers-reduced-motion.

disableAnimation

boolean

Default: false

Disables all toast animation.

regionProps

ToastRegionProps

Default: —

Extra props for the toast region container.

className

string

Default: —

Class applied to the toast region.

style

CSSProperties

Default: —

Inline styles for the toast region.

title

ReactNode

Default: —

Toast title.

description / message

ReactNode

Default: —

Toast body content.

icon

ReactNode

Default: —

Overrides the default type-derived icon.

endContent

ReactNode

Default: —

Content rendered at the end of the toast.

action

{ label: string; onClick?: () => void }

Default: —

An inline action button.

type

"default" | "info" | "success" | "warning" | "error" | "loading"

Default: derived from color, else "default"

Semantic type, also picks the default icon.

color

ToastColor

Default: —

Semantic color.

variant

"solid" | "soft" | "flat" | "bordered"

Default: "flat"

Visual style variant.

radius

OksRadius

Default: "md"

Border radius.

size

OksSize

Default: "md"

Toast size.

position

ToastPosition

Default: provider's position

Per-toast position override.

duration

number | null

Default: 6000

Auto-dismiss duration in ms; null disables auto-dismiss.

persistent

boolean

Default: false

Never auto-dismisses.

showDurationBar

boolean

Default: false

Shows a countdown progress bar.

dismissible

boolean

Default: true

Shows a close button.

promise

Promise<unknown>

Default: —

Drives the promise-aware loading/success/error flow.

onDismiss

(id: ToastId) => void

Default: —

Called when the toast is dismissed.

closeIcon

ReactNode

Default: —

Overrides the default close icon.

classNames

ToastClassNames

Default: —

Per-slot class overrides.

className

string

Default: —

Class applied to this toast's root element.