Page Component

Last update: August 29, 2022

CREATED FOR:

  • Developer
  • Admin
  • User

The Page Component is an extensible page component designed to work with the template editor and allows page header/footer and structure components to be assembled with the template editor.

Usage

The Page Component forms the basis of all pages designed with the Core Components as well as editable templates. By using the Page Component, headers, footers, and the structure of the page can be defined as a template using the other Core Components.

Using the design dialog, custom client-side libraries can be defined for the page. Unlike other components which have an edit dialog accessible directly from the component, because the Page Component is the page itself, the edit dialog of the Page Component is the page properties window.

Version and Compatibility

The current version of the Page Component is v3, which was introduced with release 2.18.0 of the Core Components in February 2022, and is described in this document.

The following table details all supported versions of the component, the AEM versions with which the versions of the component is compatible, and links to documentation for previous versions.

Component VersionAEM 6.4AEM 6.5AEM as a Cloud Service
v3-CompatibleCompatible
v2CompatibleCompatibleCompatible
v1CompatibleCompatibleCompatible

For more information about Core Component versions and releases, see the document Core Components Versions.

Progressive Web App Support

Release 2.15.0 of the Core Components introduced support for AEM as a Cloud Service’s built-in Progressive Web Apps (PWA) features. With a simple configuration at the site level, turn your AEM experience into a PWA!

Technical Details

The latest technical documentation about the Page Component can be found on GitHub.

Further details about developing Core Components can be found in the Core Components developer documentation.

Edit Dialog

Because the component represents the entire page, settings that would normally be in an edit dialog are found in the Page Properties window.

Design Dialog

Because the component represents the entire page, the design dialog is accessed via Page Information -> Page Policy when editing the page template.

Page Policy

NOTE
In previous versions of AEM, Page Policy was called Page Design.

Properties Tab

Using the Page Design window, you can define the client libraries to be loaded as well as the web resources library for the page.

  • Client Libraries - This defines the client library categories to load. JavaScript is added at the body end and the CSS is added to the page head.

  • Client Libraries JavaScript Page Head - This defines the JavaScript Client library categories to load in the page head.

    • Categories defined here that are also present in the Client Libraries field will have JavaScript loaded in the page head instead of at body end.
    • No CSS will be loaded unless the category is also present in the Client Libraries field.

  • Web Resources Client Library - The client library category that is used to serve web resources such as favicons.

  • Skip to main content element selector - Used as an accessibility feature to skip directly to the main content of the page

  • Render alternative language links - If enabled, links to alternate language versions of the page in the same site will be added to the page’s head.

Page Component design dialog

Libraries can be configured for both the Client Libraries and Client Libraries JavaScript Page Head fields as follows:

  • To add a new field click or tap the Add button below the fields.
  • To remove a field click or tap the trash can icon next to the field to be removed.
  • To rearrange the load order, click or tap and drag the handle next to the field to be moved.

For more information about using client-side libraries see Using Client Side Libraries.

CAUTION
The ability to separately define client libraries for the page head was introduced with core components release 2.2.0.