Interface ToastStackStateModel

Controlled Toast stack state model.

interface ToastStackStateModel {
    add(toast: ToastItem): readonly ToastItem[];
    clear(): readonly ToastItem[];
    dismiss(id: string): readonly ToastItem[];
    list(): readonly ToastItem[];
    prune(now: number): readonly ToastItem[];
    setOptions(options: CreateToastStackStateOptions): readonly ToastItem[];
}

Index

Methods

add clear dismiss list prune setOptions

Methods

add

add(toast: ToastItem): readonly ToastItem[]
Adds or replaces a toast and returns the visible stack.
Parameters
- toast: ToastItem
Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:107

clear

clear(): readonly ToastItem[]
Removes all toasts and returns the visible stack.

Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:110

dismiss

dismiss(id: string): readonly ToastItem[]
Removes one toast by id and returns the visible stack.
Parameters
- id: string
Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:113

list

list(): readonly ToastItem[]
Returns the visible stack.

Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:116

prune

prune(now: number): readonly ToastItem[]
Removes expired toasts for a timestamp and returns the visible stack.
Parameters
- now: number
Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:119

setOptions

setOptions(options: CreateToastStackStateOptions): readonly ToastItem[]
Replaces options while preserving current toasts unless provided.
Parameters
- options: CreateToastStackStateOptions
Returns readonly ToastItem[]
- Defined in components/feedback/toast/index.ts:122