Maia Documentation

Appearance

maia.component-library / toast

Variable: toast ​

const toast: {(message, options?): string; clear: void; close: void; danger: string; getQueue: ToastQueue<ToastContentValue>; info: string; pauseAll: void; promise: string; resumeAll: void; success: string; warning: string; } & object

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/toast/toast-queue.d.ts:48

Type Declaration ​

clear ​

clear: () => void

Returns ​

void

close ​

close: (key) => void

Parameters ​

key ​

string

Returns ​

void

danger ​

danger: (message, options?) => string

Parameters ​

message ​

ReactNode

options? ​

Omit<HeroUIToastOptions, "variant">

Returns ​

string

getQueue ​

getQueue: () => ReturnType<() => ToastQueuePrimitiveType<ToastContentValue>>

Returns ​

ReturnType<() => ToastQueuePrimitiveType<ToastContentValue>>

info ​

info: (message, options?) => string

Parameters ​

message ​

ReactNode

options? ​

Omit<HeroUIToastOptions, "variant">

Returns ​

string

pauseAll ​

pauseAll: () => void

Returns ​

void

promise ​

promise: <T>(promise, options) => string

Type Parameters ​

T ​

T

Parameters ​

promise ​

Promise<T> | (() => Promise<T>)

options ​

ToastPromiseOptions<T>

Returns ​

string

resumeAll ​

resumeAll: () => void

Returns ​

void

success ​

success: (message, options?) => string

Parameters ​

message ​

ReactNode

options? ​

Omit<HeroUIToastOptions, "variant">

Returns ​

string

warning ​

warning: (message, options?) => string

Parameters ​

message ​

ReactNode

options? ​

Omit<HeroUIToastOptions, "variant">

Returns ​

string