Interface Page

The current page to render.

Hierarchy

Page

Index

Methods

Methods

getButton

getButton(type: "MANAGE_CONTENT_LINK", button: ManageContentButton): MetaCollection
getButton(type: "EDIT_MENU_LINK", menu: Menu): MetaCollection
getButton(type: string, ...params: any[]): MetaCollection

Generates a manage content button.

Parameters
- type: "MANAGE_CONTENT_LINK"
- button: ManageContentButton
Returns MetaCollection
The manage content button meta-data.
Generates a manage menu button.

Parameters
- type: "EDIT_MENU_LINK"
- menu: Menu
Returns MetaCollection
The menu button meta-data.
Generates a meta-data collection for the Experience Manager buttons.

Parameters
- type: string
- Rest ...params: any[]
Returns MetaCollection
The button meta-data.

getChannelParameters

getChannelParameters<T>(): T

Gets current channel parameters.

Type Parameters
- T extends ChannelParameters = ChannelParameters
Returns T
The channel parameters.

getComponent

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

Gets a root component in the page.

Type Parameters
- T extends Component<T>
Returns T
The root component.
Gets a component in the page (e.g. getComponent('main', 'right')).

Type Parameters
- T extends Component<T>
Parameters
- Rest ...componentNames: string[]
  
  The names of the component and its parents.
Returns undefined | T
The component, or undefined if no such component exists.

getContent

getContent<T>(reference: string | Reference): undefined | T

Gets a content item used on the page.

Type Parameters
- T = Document
  
  The expected content type. Defaults to Document. Pass an explicit type for non-document content — e.g. ImageSet, Menu, or Pagination — to get a correctly typed result.
Parameters
- reference: string | Reference
  
  The reference to the content. It can be an object containing an RFC-6901 JSON Pointer.
Returns undefined | T

getDocument

getDocument<T>(): undefined | T

Gets the page root document. This option is available only along with the Experience Pages feature.

Type Parameters
- T
Returns undefined | T

getLocale

getLocale(): string

The page locale, defaults to en_US.

Returns string

getTitle

getTitle(): undefined | string

Returns undefined | string
The title of the page, or undefined if not configured.

getUrl

getUrl(link?: Link): undefined | string
getUrl(path: string): string

Generates a URL for a link object.
- If the link object type is internal, then it will prepend baseUrl.
- If the link object type is unknown, then it will return undefined.
- If the link parameter is omitted, then the link to the current page will be returned.
- In other cases, the link will be returned as-is.
Parameters
- Optional link: Link
  
  The link object to generate URL.
Returns undefined | string
Generates an SPA URL for the path.
- If it is a relative path, it will resolve relative to the current page URL.
- If it is an absolute path, it will resolve relative to the baseUrl option.
Parameters
- path: string
  
  The path to generate URL.
Returns string

getVersion

getVersion(): undefined | string

Returns undefined | string
The Page Model version.

getVisit

getVisit(): undefined | Visit

Returns undefined | Visit
The current visit data.

getVisitor

getVisitor(): undefined | Visitor

Returns undefined | Visitor
The current visitor data.

isPreview

isPreview(): boolean

Returns boolean
Whether the page is in the preview mode.

rewriteLinks

rewriteLinks(content: string, type?: string): string

Rewrite links to pages and resources in the HTML content. This method looks up for a tags with data-type and href attributes and img tags with src attribute. Links will be updated according to the configuration used to initialize the page.

Parameters
- content: string
  
  The HTML content to rewrite links.
- Optional type: string
  
  The content type.
Returns string

sync

sync(): void

Synchronizes the CMS integration state.

Returns void

toJSON

toJSON(): any

Returns any
A plain JavaScript object of the page model.