NotificationCenter extends KompElement

Render messages on the top layer.

Example

JS
const notificationCenter = new NotificationCenter()
document.body.append(notificationCenter)
notificationCenter.add('Success!')

Constructor

new NotificationCenter(options)
options : Object optional
content : string | HTMLElement | Array | Object optional

content for the notification, uses Dolla's content

timeout : number optional

default setting for notifications timeout

animation : boolean | Object optional

true/false to animate or not, pass object to animate with options for animate

Static Properties

P   assignableAttributes: Object

Attributes settable via constructor options. Each key is the attribute name and the value is a schema object describing how to handle it.

Example

static assignableAttributes = {
    anchor: { type: 'HTMLElement', default: null, null: true },
    placement: { type: 'string', default: 'bottom', null: false },
    enabled: { type: 'boolean', default: true, null: false },
    data: { type: 'array', default: [], null: false }
}

Properties

type : string | Array.<string>

expected type(s): 'string', 'number', 'boolean', 'object', 'array', 'function', or a class/element name like 'HTMLElement'

default : *

default value when none is provided

null : boolean

whether null is an acceptable value

load : function optional

optional transform applied when reading the attribute value

P   assignableMethods: Array

Methods overridable via constructor options

P   bindMethods: Array

Methods to auto-bind to this

P   events: Array

Event names that can be bound via onEventName constructor options

P   style: string

CSS injected once per component via adoptedStyleSheets

P   styleLayer: string | false

CSS @layer name used to wrap the component's styles when injected via adoptedStyleSheets. Set to a falsy value to disable layering.

P   watch: Array

Attributes to observe for changes. Triggers changed(attribute, was, now) and [attribute]Changed(was, now) callbacks.

Instance Methods

F   add(content, options) → Notification

Add a notification to the center

Parameters

content : string | HTMLElement | Array | Object

content for the notification, uses Dolla's content

options : Object optional

Notification options

Returns

Notification

the created notification

F   addEventListenerFor(element, eventType, args)

Listen for events on another element, automatically cleaned up when this component disconnects

Parameters

element : HTMLElement

element to listen on

eventType : string

event type

args : *

additional arguments passed to addEventListener

F   changed(attribute, was, now)

Called every time an observed attribute changes. Attribute must be listed in static watch.

Parameters

attribute : string

the attribute that changed

was : *

previous value

now : *

new value

F   connected()

Called when element is connected to the DOM

F   disconnected()

Called when element is disconnected from the DOM

F   initialize()

Called once per instantiation, but only after element is connected to the DOM

F   remove(callback) → KompElement

Remove element. Fires remove, calls optional callback, removes from DOM, then fires removed.

Parameters

callback : function optional

async callback called between remove and removed

Returns

F   trigger(eventName, args)

Trigger an event on this element

Parameters

eventName : string

event name to trigger

args : *

additional arguments

Events

E   connect

Fired before the element is connected to the DOM (cancellable)

E   connected

Fired after the element is connected to the DOM and initialized

E   disconnect

Fired before the element is disconnected from the DOM (cancellable)

E   disconnected

Fired after the element is disconnected from the DOM

E   hidden

Fired when a notification is hidden

E   remove

Fired before the element is removed (cancellable)

E   removed

Fired after the element is removed

E   shown

Fired when a notification is shown

Notes

The notification will follow the transition effects set by CSS, and adds classes -out, -out-start, -in and -in-start when hiding and showing.