JSDoc: o-comments

new Count(countEl, opts)

Class constructor.

Methods

• getCountLabel(count) - (static) Get the aria-label for the count element.

Links

• "Count" class on Github

new Stream(streamEl, opts)

Class constructor.

Methods

• publishEvent(...) - (instance) Emits events that have a valid o-comment event name.

Links

• "Stream" class on Github

Comments.getDataAttributes(rootEl)

Static Method

Get the data attributes from the element. If the component is being set up declaratively, this method is used to extract the data attributes from the DOM.

Returns

• object - - Data attributes as an object

Links

• "getDataAttributes" function on Github

Comments.init(rootEl, opts)

Static Method

Initialise the component.

Returns

• Comments | Array.<Comments> - - Comments instance(s)

Links

• "init" function on Github

Count.getCountLabel(count)

Static Method

Get the aria-label for the count element.

Returns

• string - The string that should be used as the aria-label

Links

• "getCountLabel" function on Github

Stream#publishEvent(...)

Instance Method

Emits events that have a valid o-comment event name.

Returns

• void

Links

• "publishEvent" function on Github