GitHub

Reference machines

toast

interface 3 type 5 function 1
interface Interfaces 3
interface toast/index.ts · L56

# CreateToastInput

Members

defaultDuration?
optional defaultDuration?: number

Default 5000ms.

initial?
optional initial?: ToastItem[]

Initial toasts — useful for SSR hydration.

max?
optional max?: number

Default 5; oldest dropped when full. Use Infinity to disable trim.

interface toast/index.ts · L44

# ToastContext

Members

defaultDuration
defaultDuration: number

Default duration applied to ADDs that omit it.

max
max: number

Hard limit; older toasts dropped from the front when exceeded.

toasts
toasts: readonly ToastItem[]
interface toast/index.ts · L24

# ToastItem

Members

description?
optional description?: string
duration?
optional duration?: number

Auto-dismiss delay in ms. -1 (or Infinity) = sticky. Default 5000.

id
id: string

Stable identifier — caller-supplied or generated by Layer 3.

meta?
optional meta?: Record<string, unknown>

Free-form metadata — passed back to the consumer's render.

politeness?
optional politeness?: ToastPoliteness
title
title: string
type?
optional type?: ToastType
type Type Aliases 5
type toast/index.ts · L37

# ToastEvent

ToastEvent = { toast: ToastItem; type: "ADD"; } | { id: string; type: "REMOVE"; } | { id: string; patch: Partial<Omit<ToastItem, "id">>; type: "UPDATE"; } | { type: "CLEAR"; } | { type: "SET.MAX"; value: number; }
type toast/index.ts · L22

# ToastPoliteness

ToastPoliteness = "polite" | "assertive"

ARIA-live politeness; mapped to aria-live on the toast wrapper.

function Functions 1
function toast/index.ts · L84

# createToastMachine ( )

createToastMachine(input?): ToastMachine

Construct a fresh Toast (toaster) machine.

Parameters

input?
CreateToastInput = {}

Returns

ToastMachine