The Core Component List Component allows for the easy creation of dynamic as well as static lists.
The List Component can be used to create for example a dynamic list of child pages or a static list of arbitrarily defined items. The type of lists available and formatting options can be defined by the template author in the design dialog. The content editor can select from available list types and how to format the list elements in the edit dialog.
When a page has a redirection target (regardless whether it is pointing to an external URL or to another AEM page), then a list that contains links to that point directly to the URL of the redirection target.
The current version of the List Component is v2, which was introduced with release 2.0.0 of the Core Components in January 2018, 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 Version||AEM 6.4||AEM 6.5||AEM as a Cloud Service|
For more information about Core Component versions and releases, see the document Core Components Versions.
To experience the List Component as well as see examples of its configuration options as well as HTML and JSON output, visit the Component Library.
The latest technical documentation about the List Component can be found on GitHub.
Further details about developing Core Components can be found in the Core Components developer documentation.
The edit dialog allows the content author to configure the list and the list items.
The list can be built in different ways.
Regardless of how the list is built, there are Sort and ID Options that can always be configured.
Depending on how the content author chooses to build the list, the additional configuration options will change.
The list can be built of the child pages of the current page or another page.
How many levels down in the hierarchy should be used
The list can be built using a fixed list of items.
Tap or click the Add button to inset a new item to the list.
The list can be built using the results of a search of AEM content.
The list can be built using pages that match certain tags under a particular location.
Regardless of how you choose to build the list, there are certain sorting options that can always be defined.
Using the Item Settings tab, the formatting of the list elements can be configured.
The design dialog allows the template author to define what types of lists should be allowed to the content authors as well as the available item settings.
On the List Settings tab, the date format can be defined as well as what type of lists should be available in the component to the content authors.
On the Item Settings tab, the formatting options for the individual list elements that should be available in the component for the content authors can be defined.
The Image Component supports the AEM Style System.
The List Component supports the Adobe Client Data Layer.