Class Notification

The base class for all elements in CheatGUI.

Hierarchy (View Summary)

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?: {
        closable?: boolean;
        duration?: number | false;
        text?: string;
        title?: string | null;
    },
): Notification
Parameters
- __namedParameters: {
      closable?: boolean;
      duration?: number | false;
      text?: string;
      title?: string | null;
  } = {}
Returns Notification
Overrides GUIElement.constructor
- Defined in notifications/Notification.ts:22

Properties

closeBtn

closeBtn: HTMLDivElement | null = null

closed

closed: boolean

contentRef

contentRef: HTMLDivElement

duration

duration: number | false

listeners

listeners: { [key: string]: EventCallback[] }

ref

ref: HTMLDivElement

text

text: string

timeoutId

timeoutId: any

title

title: string | null

titleRef

titleRef: HTMLDivElement | null = null

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: string[]): this
Add one or more classes to an element.
Parameters
- ...classes: string[]
Returns this
Inherited from GUIElement.addClass
- Defined in widgets/GUIElement.ts:28

close

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

destroy

destroy(): void
Destroy the element

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

getRef

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

off

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

on

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

removeClass

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

restartTimeout

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

trigger

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

updateMessage

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

updateTitle

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