Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Container

A component that holds an ordered list of container item components.

Hierarchy

Index

Methods

Methods

getChildren

getComponent

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

  • Looks up a nested component by a sequence of names (e.g. getComponent('main', 'banner')).

    Type Parameters

    Parameters

    • Rest ...componentNames: string[]

      Names of the component and its ancestors, from outermost to innermost.

    Returns undefined | U

    The matching component, or undefined if not found.

  • Returns the component itself when called with no arguments.

    Returns Container

getComponentById

  • getComponentById<U>(id: string): undefined | Container | U

  • Looks up a nested component by its id, searching the full subtree.

    Type Parameters

    Parameters

    • id: string

      The component id to find.

    Returns undefined | Container | U

    The matching component (typed as U), this component if the id matches, or undefined if not found.

getId

  • getId(): string

getMeta

getModels

  • getModels<T>(): T

getName

  • getName(): string

getParameters

  • getParameters<T>(): T

getProperties

  • getProperties<T>(): T

getType

getUrl

  • getUrl(): undefined | string

  • Returns undefined | string

    The link to the partial component model.