adobe/aem-core-wcm-components

Standardized components to build websites with AEM. https://docs.adobe.com/content/help/en/experience-manager-core-components/using/introduction.html

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.Adobe-Marketing-Cloud:aem-core-wcm-components:2.17.0'
	}
	dependencies {
		implementation("com.github.Adobe-Marketing-Cloud:aem-core-wcm-components:2.17.0")
	}
	<dependency>
	    <groupId>com.github.Adobe-Marketing-Cloud</groupId>
	    <artifactId>aem-core-wcm-components</artifactId>
	    <version>2.17.0</version>
	</dependency>

                            
    libraryDependencies += "com.github.Adobe-Marketing-Cloud" % "aem-core-wcm-components" % "2.17.0"
        
        

                            
    :dependencies [[com.github.Adobe-Marketing-Cloud/aem-core-wcm-components "2.17.0"]]

Readme

AEM WCM Core Components

Test Code Coverage Maven Central javadoc

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

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

Template Components

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

Page Authoring Components

  1. Title
  2. Text
  3. Image
  4. Button
  5. Teaser
  6. List
  7. Download
  8. PDF Viewer
  9. Embed
  10. Sharing
  11. Progress Bar
  12. Separator
  13. Experience Fragment
  14. Content Fragment
  15. Content Fragment List

Container Components

  1. Container
  2. Carousel
  3. Tabs
  4. Accordion

Form Components

  1. Core Form container
  2. Form text field
  3. Form options field
  4. Form hidden field
  5. 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

Core Components | AEM as a Cloud Service | AEM 6.5 LTS | AEM 6.5 | Java SE | Maven ----------------|------------------------|-------------|---------|---------|------- >= 2.28.x | Continual | >= 6.5 LTS GA | >= 6.5.21.0 | 8 <br/>11 | >= 3.3.9 <= 2.27.0 <br/> >= 2.26.x | Continual | Not applicable | >= 6.5.21.0 | 11 | >= 3.3.9 <= 2.25.x | Not applicable | Not applicable | <= 6.5.21.0 | 8 <br/>11 | <= 3.3.9

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 option specifies the dependencies that 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 https://github.com/adobe/aem-core-wcm-components/issues/1225