Interface RelatedContent

The related content API.

Remarks

- Available since v2.14.2.

interface RelatedContent {
    sources: RelatedContentSource[];
    addEventListener<TType extends "relatedchange">(
        type: TType | readonly TType[],
        listener: EventListener<RelatedContentEventMap[TType]>,
    ): void;
    removeEventListener<TType extends "relatedchange">(
        type: TType | readonly TType[],
        listener: EventListener<RelatedContentEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<RelatedContentEventMap>
- RelatedContent
  - UIRelatedContent

Index

Properties

Methods

addEventListener removeEventListener

Properties

sources

sources: RelatedContentSource[]

List of related content sources.

Methods

addEventListener

addEventListener<TType extends "relatedchange">(
type: TType | readonly TType[],
listener: EventListener<RelatedContentEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends "relatedchange"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<RelatedContentEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

removeEventListener

removeEventListener<TType extends "relatedchange">(
type: TType | readonly TType[],
listener: EventListener<RelatedContentEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends "relatedchange"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<RelatedContentEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener