External Module: Page

Page APIs let solutions interact with and personalize the main page, for example by setting the title or favicon, or refreshing the solution iframe.

Interfaces

• ObjectWithHref
• ObjectWithPath
• PageApi
• PageApiProperties

Type aliases

LocationLike

Ƭ LocationLike: ObjectWithHref | ObjectWithPath

Defines the location-like object for which to get the shell URL. You may specify either a path or an absolute URL.

Example:

{path: '/abc'} or {href: 'https://example.com/abc'}

Import:

Copy
import page from '@adobe/exc-app/page';
Copied to your clipboard
import page from '@adobe/exc-app/page';

Default export:

PageApi

Usage:

Copy
import page from '@adobe/exc-app/page';

page.title = 'Experience Cloud';

// Show spinner while performing an async operation
page.spinner = true;
try {
  await performOperation();
} finally {
  page.spinner = false;
}

// Generate a shell URL that directly opens the specified solution URL
const shellUrl = page.generateShellUrl('/relative/path');

// Navigate to another solution
page.shellRedirect('/target');
Copied to your clipboard
import page from '@adobe/exc-app/page';

page.title = 'Experience Cloud';

// Show spinner while performing an async operation
page.spinner = true;
try {
  await performOperation();
} finally {
  page.spinner = false;
}

// Generate a shell URL that directly opens the specified solution URL
const shellUrl = page.generateShellUrl('/relative/path');

// Navigate to another solution
page.shellRedirect('/target');

Next steps

Explore details of the Index, 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