Interface UIRelatedContent

The related content UI API which can be used to toggle UI components.

Remarks

- Available since v2.14.2.

interface UIRelatedContent {
    showing: boolean;
    sources: RelatedContentSource[];
    addEventListener<TType extends StringKeyOf<UIRelatedContentEventMap>>(
        type: TType | readonly TType[],
        listener: EventListener<UIRelatedContentEventMap[TType]>,
    ): void;
    hide(): void;
    removeEventListener<TType extends StringKeyOf<UIRelatedContentEventMap>>(
        type: TType | readonly TType[],
        listener: EventListener<UIRelatedContentEventMap[TType]>,
    ): void;
    show(): void;
}

Hierarchy (View Summary)

RelatedContent
EventDispatcher<UIRelatedContentEventMap>
- UIRelatedContent

Index

Properties

showing sources

Methods

addEventListener hide removeEventListener show

Properties

showing

showing: boolean

Whether the related content menu is showing.

sources

sources: RelatedContentSource[]

List of related content sources.

Methods

addEventListener

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

hide

hide(): void
Hides the related content menu.

Returns void

removeEventListener

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

show

show(): void
Show the related content menu.

Returns void