Interface: PageAPIProperties

Subset of page-level APIs available to solutions that are settable attributes.

Hierarchy

• PageAPIProperties

  ↳ PageAPI

Properties

favicon

• favicon: string

Gets or set the favicon for the page. If this isn't set, the default Experience Cloud favicon will be used.

Example:

Copy
page.favicon = "https://img.icons8.com/color/48/000000/thumb-up.png";
Copied to your clipboard
page.favicon = "https://img.icons8.com/color/48/000000/thumb-up.png";

modal

• modal: boolean

Configuration to show or hide a modal with full-screen overlay. Defaults to false.

Example:

Copy
page.modal = true;
Copied to your clipboard
page.modal = true;

preventDefaultCombos

• preventDefaultCombos: object[]

An array of key combinations for the shell to prevent default browser behavior, or in cases where an application performs some other action.

Example:

Copy
page.preventDefaultCombos = [
  {
    ctrlKey: true,
    key: 's'
  }
];
Copied to your clipboard
page.preventDefaultCombos = [
  {
    ctrlKey: true,
    key: 's'
  }
];

spinner

• spinner: boolean

Gets or sets a value indicating whether or not to show a spinner on the page. This configuration value is not used for the initial loading spinner (see Route Configuration hideInitialSpinner for that), but can be used to dismiss it if the spinner needs to be dismissed before a solution invokes runtime.done().

Example:

Copy
page.spinner = true;
Copied to your clipboard
page.spinner = true;

title

• title: string

Gets or sets the title of the page.

Example:

Copy
page.title = 'Adobe Experience Cloud';
Copied to your clipboard
page.title = 'Adobe Experience Cloud';

viewportTakeover

• viewportTakeover: boolean

Configuration to alter the z-index ordering of the Shell and iframe based on whether viewport takeover is needed.

Some applications will need to open a view that takes up the entire viewport of the browser. This works by increasing the size of the iframe to the full height of the viewport, and using the z-index property to alternate between header and content (iframe) on top. To make this work seamlessly, a DOM element with id="shell-placeholder" is automatically added to the top of the document.body container. The Unified Shell adds a height property to the DOM element, effectively pushing down the rest of the application's UI below the Shell UI.

By default, the Shell will have a higher z-index than the iframe, so it will be usable. In order to alternate the z-index values, putting the iframe above the Shell, set:

Copy
page.viewportTakeover = true;
Copied to your clipboard
page.viewportTakeover = true;

Now the solution application is 100% of the browser's viewport and can open any views at 100%. When the takeover is complete, set the value back to false to return the Shell to the top of the application.

Next steps

Explore details of the Index, Page, TopBar, and User external modules.

Explore the attributes and behavior of Adobe Experience Cloud Interfaces:

Modules

Runtime

Return to the Guides Index.

Last updated 12/10/2024

Was this helpful?

Yes

No