Class

DOMMessaging

DOMMessaging()

Basic DOMMessaging mixin that supports creating and removing messages from a DOMElement

Constructor

# new DOMMessaging()

Properties:
Name Type Description
$MessageAnchor

The anchor element where the $MessageNode will be rigged to

$MessageContainerClassName

The $MessageNode default class name

$MessageClassName

The individual message nodes default class name

$MessageNode

The node where messages will be appended

View Source lib/DOMMessaging.ts, line 12

Classes

DOMMessaging

Methods

# addMessage(message, statusopt)

Adds a unique message to the $MessageNode

Parameters:
Name Type Attributes Description
message

The message to append

status <optional>

An optional class to append indicating message status

View Source lib/DOMMessaging.ts, line 104

If the $MessageNode isn't set or isn't an HTMLElement

# addMessages(messages, statusopt)

Batch append messages

Parameters:
Name Type Attributes Description
messages

The messages to append

status <optional>

An optional class to append indicating message status

View Source lib/DOMMessaging.ts, line 125

If the $MessageNode isn't set or isn't an HTMLElement

# clearMessages()

Clear all messages from the $MessageNode (If set)

View Source lib/DOMMessaging.ts, line 146

# generateMessageNode(anchoropt, posopt)

Generate a messageNode where messages can be added and removed in a managed way.

Parameters:
Name Type Attributes Description
anchor <optional>

The anchor to use for the $MessageNode (Defaults to $MessageAnchor)

pos <optional>

The position to set $MessageNode inside the $MessageAnchor

View Source lib/DOMMessaging.ts, line 68

If anchor isn't an Element

If pos isn't a valid

VerticalPosition

# removeMessage(message)

Remove a message

Parameters:
Name Type Description
message

The message to remove

View Source lib/DOMMessaging.ts, line 135

If the $MessageNode isn't set or isn't an HTMLElement

# removeMessageNode()

Removes the $MessageNode from the $MessageAnchor

View Source lib/DOMMessaging.ts, line 92

If the $MessageNode isn't set or isn't an HTMLElement