toast

const toast: object

Defined in: src/core/toast.ts:173

Imperative toast API. Each level helper returns the new toast’s id.

toast.info("Saved");
toast.error("Upload failed", { duration: 0 }); // sticky
const id = toast.warn("Reconnecting…");
toast.dismiss(id);

Type Declaration

clear

clear: () => void

Dismiss all toasts.

Returns

void

dismiss

dismiss: (id) => void

Dismiss a toast by id.

Parameters

id

number

Returns

void

error

error: (message, opts?) => number

Error toast (sticky by default).

Parameters

message

string

opts?

Omit<ToastOptions, "message" | "level">

Returns

number

generic

generic: (message, opts?) => number

Neutral toast.

Parameters

message

string

opts?

Omit<ToastOptions, "message" | "level">

Returns

number

info

info: (message, opts?) => number

Info toast.

Parameters

message

string

opts?

Omit<ToastOptions, "message" | "level">

Returns

number

show

show: (opts) => number

Raise a toast from full options; returns its id.

Parameters

opts

ToastOptions

Returns

number

success

success: (message, opts?) => number

Success toast.

Parameters

message

string

opts?

Omit<ToastOptions, "message" | "level">

Returns

number

warn

warn: (message, opts?) => number

Warning toast.

Parameters

message

string

opts?

Omit<ToastOptions, "message" | "level">

Returns

number