Interface ToastOptions

Toast queue ownership and capacity options.

interface ToastOptions {
    getToasts?: () => readonly ToastRecord[];
    maxVisible?: number;
    onToastsChange?: (
        toasts: readonly ToastRecord[],
        details: ChangeDetails<ToastChangeReason>,
    ) => void;
    subscribeToasts?: (listener: () => void) => Unsubscribe;
}

Index

Properties

getToasts? maxVisible? onToastsChange? subscribeToasts?

Properties

`Optional` `Readonly`getToasts

getToasts?: () => readonly ToastRecord[]

Consumer-owned record reader.

`Optional` `Readonly`maxVisible

maxVisible?: number

Maximum concurrently visible records.

Default Value

3

`Optional` `Readonly`onToastsChange

onToastsChange?: (
toasts: readonly ToastRecord[],
details: ChangeDetails<ToastChangeReason>,
) => void

Receives queue mutation requests in controlled mode.

`Optional` `Readonly`subscribeToasts

subscribeToasts?: (listener: () => void) => Unsubscribe

Subscribes to consumer-owned queue changes.