Interface Component

A component in the current page.

Hierarchy

Component
- ContainerItem
- Container

Index

Methods

Methods

getChildren

getChildren(): Component[]

Returns Component[]
The direct children of the component.

getComponent

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

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

Type Parameters
- U extends Component<U>
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 Component

getComponentById

getComponentById<U>(id: string): undefined | Component | U

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

Type Parameters
- U extends Component<U>
Parameters
- id: string
  
  The component id to find.
Returns undefined | Component | U
The matching component (typed as U), this component if the id matches, or undefined if not found.

getId

getId(): string

Returns string
The component id.

getMeta

getMeta(): MetaCollection

Returns MetaCollection
The component meta-data collection.

getModels

getModels<T>(): T

Type Parameters
- T extends ComponentModels
Returns T
The map of the component models.

getName

getName(): string

Returns string
The name of the component.

getParameters

getParameters<T>(): T

Type Parameters
- T = ComponentParameters
Returns T
The parameters of the component.

getProperties

getProperties<T>(): T

alias
getParameters

Type Parameters
- T = ComponentParameters
Returns T
The properties of the component.

getUrl

getUrl(): undefined | string

Returns undefined | string
The link to the partial component model.