Download Component
The Core Component Download component allows for the creation of a download option on a page.
Usage
The Core Component Download component allows for the inclusion of a download option and its associated asset on a page.
- The download option’s properties can be selected in the configure dialog.
- Defaults for the download component can be defined in the design dialog.
Version and Compatibility
The current version of the Download Component is v2, 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.
For more information about Core Component versions and releases, see the document Core Components Versions.
Sample Component Output
To experience the Download Component as well as see examples of its configuration options as well as HTML and JSON output, visit the Component Library.
Technical Details
The latest technical documentation about the Download Component can be found on GitHub.
Further details about developing Core Components can be found in the Core Components developer documentation.
Configure Dialog
The configure dialog allows the content author to define the download item and how it will behave and appear for a visitor to the page.
Asset Tab
The selection of a download asset is very similar to the functionality of the Image Component and likewise leverages AEM’s DAM.
-
Download Asset
- Drop an asset from the asset browser or tap the browse option to upload from a local file system.
- Tap or click Clear to de-select the currently selected image.
- Tap or click Edit to mange the renditions of the asset in the asset editor.
Properties Tab
-
Title - Displays as a headline for the download item
- Get title from DAM asset - When selected, the title is automatically populated with the DAM asset’s title.
-
Description - Displays as a descriptive subheadline of the download item
- Get description from DAM asset - When selected, the description is automatically populated with the DAM asset’s description.
-
Action Text - Displays as action text for the download item
- This field is required when uploading an asset from the file system.
- Display inline - When selected the provided Action Text will display inline.
-
ID - This option allows to control the unique identifier of the component in the HTML and in the Data Layer.
- If left blank, a unique ID is automatically generated for you and can be found by inspecting the resulting page.
- If an ID is specified, it is the responsibility of the author to make sure that it is unique.
- Changing the ID can have an impact on CSS, JS and Data Layer tracking.
Styles Tab
The Download Component supports the AEM Style System..
Use the drop-down to select the styles that you want to apply to the component. Selections made in the edit dialog have the same effect as those chosen from the component toolbar.
Styles must be configured for this component in the design dialog in order for the drop down menu to be available.
Design Dialog
The design dialog allows the template author to define the options available to the content author who uses the Download Component.
Properties Tab
- Allow upload from file system - Allows the content author to upload an asset from his/her local filesystem as the download asset.
- The default value is unselected.
- Title Type - The HTML element used for the Download Component’s title.
- If no value is selected, the default value is H3.
- Display File Size - When selected the file size of the asset will be displayed in the download component.
- The default value is selected.
- Display File Format - When selected the file format of the asset will be displayed in the download component.
- The default value is selected.
- Display Filename - When selected the filename of the asset will be displayed in the download component.
- The default value is selected.
Styles Tab
The Image Component supports the AEM Style System.