@serenity-is/corelib / Toastr

Class: Toastr

Table of contents

Constructors

• constructor

Properties

• listener
• options
• previousToast
• toastId

Methods

• clear
• clearContainer
• clearToast
• createContainer
• error
• getContainer
• info
• notify
• publish
• remove
• removeToast
• subscribe
• success
• warning

Constructors

constructor

• new Toastr(options?)

Parameters

Name	Type
options?	ToastrOptions

Defined in

src/q/toastr2.ts:88

Properties

listener

• Private listener: any

Defined in

src/q/toastr2.ts:80

---

options

• options: ToastrOptions

Defined in

src/q/toastr2.ts:86

---

previousToast

• Private previousToast: string = null

Defined in

src/q/toastr2.ts:84

---

toastId

• Private toastId: number = 0

Defined in

src/q/toastr2.ts:82

Methods

clear

▸ clear(toastElement?, clearOptions?): void

Parameters

Name	Type
toastElement?	HTMLElement
clearOptions	Object
clearOptions.force?	boolean

Returns

void

Defined in

src/q/toastr2.ts:185

---

clearContainer

▸ Private clearContainer(options?): void

Parameters

Name	Type
options	Partial<ToastrOptions>

Returns

void

Defined in

src/q/toastr2.ts:235

---

clearToast

▸ Private clearToast(toastElement?, options?, clearOptions?): boolean

Parameters

Name	Type
toastElement?	HTMLElement
options?	ToastContainerOptions
clearOptions	Object
clearOptions.force?	boolean

Returns

boolean

Defined in

src/q/toastr2.ts:247

---

createContainer

▸ Private createContainer(options?): HTMLElement

Parameters

Name	Type
options	ToastContainerOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:93

---

error

▸ error(message?, title?, opt?): HTMLElement

Parameters

Name	Type
message?	string
title?	string
opt?	ToastrOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:121

---

getContainer

▸ getContainer(options?, create?): HTMLElement

Parameters

Name	Type	Default value
options?	ToastContainerOptions	undefined
create	boolean	false

Returns

HTMLElement

Defined in

src/q/toastr2.ts:109

---

info

▸ info(message?, title?, opt?): HTMLElement

Parameters

Name	Type
message?	string
title?	string
opt?	ToastrOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:160

---

notify

▸ Private notify(map, opt): HTMLElement

Parameters

Name	Type
map	NotifyMap
opt	ToastrOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:266

---

publish

▸ publish(args): void

Parameters

Name	Type
args	Toastr

Returns

void

Defined in

src/q/toastr2.ts:177

---

remove

▸ remove(toastElement?): void

Parameters

Name	Type
toastElement?	HTMLElement

Returns

void

Defined in

src/q/toastr2.ts:191

---

removeToast

▸ removeToast(toastElement, options?): void

Parameters

Name	Type
toastElement	HTMLElement
options	ToastrOptions

Returns

void

Defined in

src/q/toastr2.ts:211

---

subscribe

▸ subscribe(callback): void

Parameters

Name	Type
callback	(response: Toastr) => void

Returns

void

Defined in

src/q/toastr2.ts:173

---

success

▸ success(message?, title?, opt?): HTMLElement

Parameters

Name	Type
message?	string
title?	string
opt?	ToastrOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:147

---

warning

▸ warning(message?, title?, opt?): HTMLElement

Parameters

Name	Type
message?	string
title?	string
opt?	ToastrOptions

Returns

HTMLElement

Defined in

src/q/toastr2.ts:134