Maia Documentation

Appearance

maia.component-library / ToastQueue

Class: ToastQueue<T> ​

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

Type Parameters ​

T ​

T extends object = ToastContentValue

Constructors ​

Constructor ​

new ToastQueue<T>(options?): ToastQueue<T>

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

Parameters ​

options? ​

ToastQueueOptions

Returns ​

ToastQueue<T>

Properties ​

maxVisibleToasts? ​

readonly optional maxVisibleToasts?: number

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

Accessors ​

visibleToasts ​

Get Signature ​

get visibleToasts(): QueuedToast<T>[]

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

Returns ​

QueuedToast<T>[]

Methods ​

add() ​

add(content, options?): string

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

Parameters ​

content ​

T

options? ​

ToastOptions

Returns ​

string

clear() ​

clear(): void

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

Returns ​

void

close() ​

close(key): void

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

Parameters ​

key ​

string

Returns ​

void

getQueue() ​

getQueue(): ToastQueue<T>

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

Returns ​

ToastQueue<T>

pauseAll() ​

pauseAll(): void

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

Returns ​

void

resumeAll() ​

resumeAll(): void

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

Returns ​

void

subscribe() ​

subscribe(fn): () => void

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

Parameters ​

fn ​

() => void

Returns ​

() => void