JarCastingAEM 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.
Usability Study 2020
We're conducting a usability study by using the System Usability Scale, a reliable tool to measure the perceived usability.
Please help us making the Core Components better by responding to our short usability questionnaire. Thank you!
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: 28 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 (known issues).
- 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.
- Versionned: 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
Page Authoring Components
- Title
- Text
- Image
- Button
- Teaser
- List
- Download
- PDF Viewer
- Embed
- Sharing
- Progress Bar
- Separator
- Experience Fragment
- Content Fragment
- Content Fragment List
Container Components
Form Components
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
| Core Components | AEM as a Cloud Service | AEM 6.5 | AEM 6.4 | Java SE | Maven |
|---|---|---|---|---|---|
| 2.13.0 | Continual | 6.5.5.0+ (*) | 6.4.8.1+ (*) | 8, 11 | 3.3.9+ |
(*) - Since version 2.11.0 org.apache.sling.models.impl version 1.4.12 or higher is required (due to SLING-8781). This will be provided for AEM 6.4 and 6.5 in a future Service Pack. Until then, the Sling Models bundle is included in the core.wcm.components.all package.
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 -PautoInstallSinglePackage
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
Note that:
-pl/-projectsoption specifies the list of projects that you want to install-am/-also-makeoptions specifies that dependencies should also be built
For convenience, the following deployment profiles are provided when running the Maven install goal with mvn install:
autoInstallSinglePackage: Install everything to the AEM author instance.autoInstallSinglePackagePublish: Install everything to the AEM publish instance.autoInstallPackage: Install theui.contentandui.appscontent packages to the AEM author instance.autoInstallPackagePublish: Install theui.contentandui.appscontent packages to the AEM publish instance.
The hostname and port of the instance can be changed with the following user defined properties:
aem.hostandaem.portfor the author instance.aem.publish.hostandaem.publish.portfor the publish instance.
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 https://github.com/adobe/aem-core-wcm-components/issues/1225
