Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContainerItem

A component that can be configured in the UI.

Hierarchy

Index

Methods

getChildren

getComponent

  • getComponent<U>(...componentNames: string[]): U | undefined
  • getComponent(): this
  • Looks up for a nested component.

    Type parameters

    Parameters

    • Rest ...componentNames: string[]

      A lookup path.

    Returns U | undefined

  • Returns this

getComponentById

  • getComponentById<U>(id: string): U | this | undefined
  • Looks up for a nested component by its id.

    Type parameters

    Parameters

    • id: string

      A component id.

    Returns U | this | undefined

getId

  • getId(): string
  • Returns string

    The component id.

getMeta

  • Returns Meta[]

    The component meta-data collection.

getModels

  • getModels<T>(): T
  • Type parameters

    • T: ComponentModels

    Returns T

    The map of the component models.

getName

  • getName(): string
  • Returns string

    The name of the component.

getParameters

  • getParameters(): ComponentParameters
  • Returns ComponentParameters

    The parameters of the component.

getType

  • getType(): string | undefined
  • Returns the type of a container item. The available types depend on which container items have been configured in the backend.

    Returns string | undefined

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

getUrl

  • getUrl(): string | undefined
  • Returns string | undefined

    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: Extract<keyof ContainerItemEvents, string>

    Parameters

    Returns void

on

  • Subscribes for an event.

    Type parameters

    • U: Extract<keyof ContainerItemEvents, string>

    Parameters

    Returns UnsubscribeFn

    The unsubscribe function.