Interface ToastHandle

Imperative handle returned by toast.

interface ToastHandle {
    add(toast: ToastItem): readonly ToastItem[];
    clear(): readonly ToastItem[];
    dismiss(id: string): readonly ToastItem[];
    items(): readonly ToastItem[];
    prune(now: number): readonly ToastItem[];
    element: BoxElement;
    destroy(): void;
    setData(data: ToastData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<ToastData, blessed.Widgets.BoxElement>
- ToastHandle

Index

Properties

Methods

add clear dismiss items prune destroy setData

Properties

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

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 adapters/blessed/toast.ts:40

clear

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

Returns readonly ToastItem[]
- Defined in adapters/blessed/toast.ts:43

dismiss

dismiss(id: string): readonly ToastItem[]
Removes one toast by id and returns the visible stack.
Parameters
- id: string
Returns readonly ToastItem[]
- Defined in adapters/blessed/toast.ts:46

items

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

Returns readonly ToastItem[]
- Defined in adapters/blessed/toast.ts:49

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 adapters/blessed/toast.ts:52

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: ToastData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: ToastData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31