AEM WCM Core Components

Set of standardized Web Content Management (WCM) components for Adobe Experience Manager (AEM) to speed up development time and reduce maintenance cost of your websites.

Welcome

• Contributions are welcome, read our contributing guide for more information.
• Ideas and questions are discussed on our public mailing list; you can also subscribe via email.

Documentation

• Component Library: A collection of examples to view the components in their various configurations.
• Component Documentation: For developers and authors, with details about each component.
• Get Started:
  • WKND Tutorial: A two-day tutorial for building a new site.
  • Summit Tutorial: A two-hour tutorial for building a new site (from a Lab at US Summit 2019).
  • Gems Webinar: A guided tour of the Core Components (recorded on Dec 2018).

Features

• Production-Ready: 29 robust components that are well tested, widely used, and that perform well.
• Cloud-Ready: Whether on AEM as a Cloud Service, on Adobe Managed Services, or on-premise, they just work.
• Versatile: The components represent generic concepts with which the authors can assemble nearly any layout.
• Configurable: Template-level content policies define which features the page authors are allowed to use or not.
• Trackable: The Adobe Client Data Layer integration allows to track all aspects of the visitor experience.
• Accessible: They comply WCAG 2.1 standard, provide ARIA labels, and support keyboard navigation.
• SEO-Friendly: The HTML output is semantic and provides schema.org microdata annotations.
• WebApp-Ready: The streamlined JSON output allows client-side rendering, still with a possibility of in-context editing.
• Design Kit: A UI kit for Adobe XD allows designers to create wireframes that they can then style as needed.
• Themeable: The components implement the Style System, and the markup follows BEM CSS conventions.
• Customizable: Several patterns allow easy customization, from adjusting the HTML to advanced functionality reuse.
• Versioned: The versioning policy ensures we won't break your site when improving things that might impact you.
• Open Sourced: If something is not as it should, contribute your improvements!

Template Components

1. Page
2. Navigation
3. Language Navigation
4. Breadcrumb
5. Quick Search
6. Table of Contents

Page Authoring Components

6. Title
7. Text
8. Image
9. Button
10. Teaser
11. List
12. Download
13. PDF Viewer
14. Embed
15. Sharing
16. Progress Bar
17. Separator
18. Experience Fragment
19. Content Fragment
20. Content Fragment List

Container Components

21. Container
22. Carousel
23. Tabs
24. Accordion

Form Components

25. Core Form container
26. Form text field
27. Form options field
28. Form hidden field
29. Form button

Roadmap

To learn about the main upcoming components and features, visit the roadmap wiki page.

Usage

To include the Core Components in a new project, we strongly advise to use the AEM Project Archetype; this guarantees a starting point that complies to all recommended practices from Adobe.

For existing projects, take example from the AEM Project Archetype by looking at the core.wcm.components references in the main pom.xml, in all/pom.xml, and in ui.apps/pom.xml. For the rest, make sure to create Proxy Components, to load the client libraries and to allow the components on the template, as instructed in Using Core Components.

System Requirements

For the requirements from previous Core Component releases, see Historical System Requirements.

The Core Components require the use of editable templates and do not support Classic UI nor static templates. If needed, check out the AEM Modernization Tools.

Setup your local development environment for AEM as a Cloud Service SDK or for older versions of AEM.

Building

To compile your own version of the Core Components, you can build and install everything on your running AEM instance by issuing the following command in the top level folder of the project:

mvn clean install -PautoInstallPackage

You can also install individual packages/bundles by issuing the following command in the top-level folder of the project:

mvn clean install -PautoInstallPackage -pl <project_name(s)> -am

With AEM as a Cloud Service SDK, use the cloud profile as follows to deploy the components into /libs instead of /apps:

mvn clean install -PautoInstallPackage,cloud

Note that:

• -pl/-projects option specifies the list of projects that you want to install
• -am/-also-make options specifies that dependencies should also be built

For detailed informations see BUILDING.md.

Configuration

The Core Components leverage both OSGi configurations and Sling context-aware configurations. For a description of defined configurations see CONFIGS.md

Known Issues

• The provided oEmbed URL Processor configuration for Facebook and Instagram is not working at the moment as a new version of the endpoint was released by Facebook and now an access token needs to be passed in the request. A possible workaround is described in #1225