Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContainerItem

A component that can be configured in the UI.

Hierarchy

Index

Methods

Methods

getChildren

getComponent

  • getComponent<U>(...componentNames: string[]): undefined | U
  • getComponent(): ContainerItem

getComponentById

getContent

  • getContent<T>(page: Page): null | T

  • Returns the content of this component.

    Type Parameters

    • T

    Parameters

    • page: Page

      The page that contains the content

    Returns null | T

getContentReference

  • Returns a RFC-6901 JSON Pointer to the content of this container item.

    Returns undefined | Reference

getId

  • getId(): string

getLabel

  • getLabel(): undefined | string

  • Returns the label of a container item catalogue component.

    Returns undefined | string

    The label of a catalogue component (e.g. "News List").

getMeta

getModels

  • getModels<T>(): T

getName

  • getName(): string

getParameters

  • getParameters<T>(): T

getProperties

  • getProperties<T>(): T

getType

  • getType(): undefined | string

  • Returns the type of a container item. The available types depend on which container items have been configured in the backend.

    Returns undefined | string

    The type of a container item (e.g. "Banner").

getUrl

  • getUrl(): undefined | string

  • Returns undefined | string

    The link to the partial component model.

isHidden

  • isHidden(): boolean

  • Returns whether the component should not render anything. Hiding components is only possible with the Relevance feature.

    Returns boolean

    Whether the component is hidden or not.

off

  • Unsubscribes from an event.

    Type Parameters

    • U extends "update"

    Parameters

    Returns void

on