Class Notification

The base class for all elements in CheatGUI.

Hierarchy (view full)

GUIElement
- Notification

Index

Constructors

Properties

closeBtn closed contentRef duration listeners ref text timeoutId title titleRef view

Methods

_init addClass close destroy getRef off on removeClass restartTimeout trigger updateMessage updateTitle

Constructors

constructor

new Notification(__namedParameters?): Notification
Parameters
- __namedParameters: {
      closable?: boolean;
      duration?: number | false;
      text?: string;
      title?: string;
  } = {}
  - Optionalclosable?: boolean
  - Optionalduration?: number | false
  - Optionaltext?: string
  - Optionaltitle?: string
Returns Notification
Overrides GUIElement.constructor
- Defined in notifications/Notification.ts:21

Properties

closeBtn

closeBtn: HTMLDivElement

closed

closed: boolean

contentRef

contentRef: HTMLDivElement

duration

duration: number | false

listeners

listeners: {
[key: string]: Function[];
}

ref

ref: HTMLElement

text

text: string

timeoutId

timeoutId: any

title

title: string

titleRef

titleRef: HTMLDivElement

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Inherited from GUIElement._init
- Defined in widgets/GUIElement.ts:19

addClass

addClass(...classes): this
Add one or more classes to an element.
Parameters
- Rest...classes: string[]
Returns this
Inherited from GUIElement.addClass
- Defined in widgets/GUIElement.ts:28

close

close(): void
Returns void
- Defined in notifications/Notification.ts:102

destroy

destroy(): void
Destroy the element

Returns void
Inherited from GUIElement.destroy
- Defined in widgets/GUIElement.ts:53

getRef

getRef(): HTMLElement
Returns HTMLElement
Inherited from GUIElement.getRef
- Defined in widgets/GUIElement.ts:46

off

off(event, callback): void
Parameters
- event: string
- callback: Function
Returns void
Inherited from GUIElement.off
- Defined in EventSupport.ts:16

on

on(event, callback): void
Parameters
- event: string
- callback: Function
Returns void
Inherited from GUIElement.on
- Defined in EventSupport.ts:11

removeClass

removeClass(...classes): this
Remove one or more classes from an element.
Parameters
- Rest...classes: string[]
Returns this
Inherited from GUIElement.removeClass
- Defined in widgets/GUIElement.ts:38

restartTimeout

restartTimeout(): this
Returns this
- Defined in notifications/Notification.ts:88

trigger

trigger(event, ...args): void
Parameters
- event: string
- Rest...args: any[]
Returns void
Inherited from GUIElement.trigger
- Defined in EventSupport.ts:22

updateMessage

updateMessage(message): this
Parameters
- message: string
Returns this
- Defined in notifications/Notification.ts:82

updateTitle

updateTitle(): this
Returns this
- Defined in notifications/Notification.ts:72