The Email Image Component is an adaptive image component that features in-place editing.
The Email Image Component features adaptive image selection and responsive behavior with lazy loading for the page visitor as well as easy drag-and-drop image placement and configuration for the content author.
The current version of the Email Image Component is v1, which was introduced with release x of the Email Core Components in October 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.
Component Version | AEM 6.5 | AEM as a Cloud Service |
---|---|---|
v1 | Compatible | Compatible |
For more information about Core Component versions and releases, see the document Email Core Components Versions.
The Email Image Component comes with robust responsive features ready right out of the box. At the page template level, the design dialog can be used to define the default widths of the image asset. The Email Image Component will then automatically load the correct width to display depending on the size of the browser window. As the window is resized, the Email Image Component dynamically loads the correct image size on the fly. There is no need for component developers to worry about defining custom media queries since the Email Image Component is already optimized to load your content.
In addition, the Email Image Component supports lazy loading to defer loading of the actual image asset until it is visible in the browser, increasing the responsiveness of your content.
By default, the Email Image Component is powered by the Adaptive Image Servlet. Please see the document Adaptive Image Servlet for details on how it works.
The Email Image Component supports Dynamic Media assets. When enabled, these features offer the ability to add Dynamic Media image assets with a simple drag-and-drop or via the assets browser just as you would any other image. In addition, image modifiers, image presets, and smart crops are also supported.
Your email experiences built with the Email Core Components can feature rich, Sensei-powered, robust, high-performance, cross-platform Dynamic Media Image capabilities.
Scalable Vector Graphics (SVG) are supported by the Email Image Component.
For security reasons, the original SVG is never called directly by the Image Editor. It is called through <img src=“path-to-component”>
. This prevents the browser from executing any scripts embedded in the SVG file.
To experience the Email Image 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 Email Image Component can be found on GitHub.
Further details about developing Core Components can be found in the Core Components developer documentation.
The Image Component supports schema.org microdata.
The Email Image Component offers a configure dialog where the image itself is defined along with its description and basic properties.
Inherit featured image from page - This option uses the featured image of the linked page or the featured image of the current page if the image is not linked.
Alternative text for accessibility - This field allows you to define a description of the image for visually impaired users.
dc:description
metadata in DAM or of the current page if no asset is linked.Image asset
Don’t provide an alternative text - This option marks the image to be ignored by assistive technologies like screen readers for cases where the image is purely decorative or otherwise conveys no additional information to the page.
Disable lazy loading - This option preloads all image components without loading as needed.
&
, regardless of which Preset Type is selected.dc:title
metadata in DAM. Only available when an asset is chosen from the DAM."width":"100%"
to the image style attribute.Smart Crop and Image Preset are mutually exclusive options. If an author needs to use an image preset along with a Smart Crop rendition, the author will have to use the Image Modifiers to manually add presets.
The Email Image 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 tab to be available.
You can define a list of widths in pixels for the image and the component will automatically load the most appropriate width based on browser size. This is an important part of the responsive features of the Email Image Component.
See the document Adaptive Image Servlet for tips for optimizing rendition selection by carefully defining your widths.
The Email Image Component supports the AEM Style System.