Notification

Notification

new Notification(element, options)

Source:
Parameters:
Name Type Description
element HTMLElement

DOM element for component instantiation and scope

options Object
Properties
Name Type Description
closeSelector String

Selector for closing the notification

attachClickListener Boolean

Whether or not to bind click events

Classes

Notification

Methods

destroy()

Description:
  • Destroy component.

Source:

handleClickOnClose(e)

Description:
  • Remove the notification component.

Source:
Parameters:
Name Type Description
e Event
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:
Name Type Description
eventName string

The name of the event to listen for.

callback function

The callback function to be invoked when the event occurs.

Returns:
Type
void

trigger(eventName, eventData)

Description:
  • Trigger a component event.

Source:
Parameters:
Name Type Description
eventName string

The name of the event to trigger.

eventData any

Data associated with the event.

(static) autoInit(root) → {Notification}

Source:
Parameters:
Name Type Description
root HTMLElement

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>