Notification

Notification

new Notification(element, options)

Source:
Parameters:
NameTypeDescription
elementHTMLElement

DOM element for component instantiation and scope

optionsObject
Properties
NameTypeDescription
closeSelectorString

Selector for closing the notification

attachClickListenerBoolean

Whether or not to bind click events

Classes

Notification

Methods

destroy()

Description:
  • Destroy component.

Source:

handleClickOnClose(e)

Description:
  • Remove the notification component.

Source:
Parameters:
NameTypeDescription
eEvent
Fires:

init()

Description:
  • Initialise component.

Source:

on(eventName, callback) → {void}

Description:
  • Register a callback function for a specific event.

Source:
Example
// Registering a callback for the 'close' event
notification.on('onClose', (event) => {
  console.log('Close event occurred!', event);
});
Parameters:
NameTypeDescription
eventNamestring

The name of the event to listen for.

callbackfunction

The callback function to be invoked when the event occurs.

Returns:
Type
void

trigger(eventName, eventData)

Description:
  • Trigger a component event.

Source:
Parameters:
NameTypeDescription
eventNamestring

The name of the event to trigger.

eventDataany

Data associated with the event.

(static) autoInit(root) → {Notification}

Source:
Parameters:
NameTypeDescription
rootHTMLElement

DOM element for component instantiation and scope

Returns:

An instance of Notification.

Type
Notification

Events

onClose

Description:
  • An array of supported events for this component.

Source:
Type:
  • Array.<string>