AEPImage
The AEPImage class is a fundamental UI component used to display images for content cards.
Images can be displayed from various sources (URL, bundle, or SF Symbols) and their appearance can be customized.
AEPImage conforms to ObservableObject, allowing it to be used reactively in SwiftUI views.
Image Sources
The AEPImage class supports multiple sources for displaying images, with built-in support for both light and dark mode variants.
Image sources are prioritized in the following order:
- URL images
- Bundled resource images
- SF Symbol icons
Public properties
| Property | Type | Description | Default Value |
|---|---|---|---|
contentMode | The content mode of the image. | ||
modifier | AEPViewModifier | A custom view modifier that can be applied to the text view for additional styling. | N/A |
icon | String | The name of the SF Symbol icon used in the image. This applies only to images sourced from icons. | N/A |
iconFont | The font of the SF Symbol icon used in the image. This applies only to images sourced from icons. | N/A | |
iconColor | The color of the SF Symbol icon used in the image. This applies only to images sourced from icons. |
All properties are marked with @Published. Any changes will trigger updates to the UI.
Customization
You can customize AEPImage properties when working with a template that includes an image. Here's an example:
Swift
Copied to your clipboardclass MyCustomizer: ContentCardCustomizing {func customize(template: SmallImageTemplate) {// Customize the image elementtemplate.image.contentMode = .filltemplate.image.modifier = AEPViewModifier(MyImageModifier())// Customize the dismiss button// dismiss buttons are images sourced from SF Symbols iconstemplate.dismissButton?.image.iconName = "xmark" // SF Symbol nametemplate.dismissButton?.image.iconColor = .primarytemplate.dismissButton?.image.iconFont = .system(size: 10)}struct MyImageModifier: ViewModifier {func body(content: Content) -> some View {content.clipShape(Circle()).overlay(Circle().stroke(Color.red, lineWidth: 2))}}}
