UiScope | @bloomreach/ui-extension

API to access information about and communicate with the CMS that loads the UI extension.

Index

baseUrl: string

The base URL of the CMS, without any query parameters.

API for the current channel.

API for dialogs.

API for the current document.

extension: { config: string }

Properties of this UI extension.

config: string

The configuration of this UI extension. How to interpret the string (e.g. parse as JSON) is up to the implementation of the UI extension.

locale: string

The locale of the CMS user as selected in the login page. For example: "en".

The styling of the user interface in which the extension is shown.

timeZone: string

The time zone of the CMS user as selected on the login page. For example: "Europe/Amsterdam".

user: { displayName: string; firstName: string; id: string; lastName: string }

Properties of the CMS user.

displayName: string

Concatenation of the first and last name of the CMS user, or the username if both are blank. For example: "Suzanna Doe" or "admin".
firstName: string

The first name of the CMS user. For example: "Suzanna".
id: string

The username of the CMS user. For example: "admin".
lastName: string

The last name of the CMS user. For example: "Doe".

version: string

The version of the CMS. For example: "13.0.0".