Page History
(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)
Image Displayer
Link to Figma: tba
Overview
- The Dynamic Image Displayer component shows images on a page.
- It supports different sizing and display strategies.
- Developers can set custom dimensions or let the component auto-size.
- Events allow interactions such as clicks and lifecycle handling.
- Visibility and authorization settings control when and for whom the image is shown.
...
- visibilityPolicySetId – Determines whether the component is displayed based on a policy set. This allows showing the image only to users with specific permissions. Example: "contentViewerPolicy".
Guidelines
[NO DATA AVAILABLE]
Accessibility
Usage
- Bind visual content with
imageUrl(template expressions allowed) and always provide an appropriatealt. - Choose an explicit sizing mode via
resizeImageStrategy: fitToContainerfor aspect-preserving photos/illustrations.useStaticSizewithwidth/heightfor predictable thumbnails.useRealSizefor pixel-accurate assets.fillWholeContentonly when distortion is acceptable.- Control when the component renders with
displayConditions; restrict access withvisibilityPolicySetId.
Sizing & Layout
- Prefer intrinsic sizing when appropriate using
widthAuto/heightAuto. - For fixed dimensions, pair
resizeImageStrategy: "useStaticSize"withwidthand/orheight. - Preserve aspect ratio with
resizeImageStrategy: "fitToContainer"; reserve"fillWholeContent"for deliberate stretch. - Use
paddingClassto add touch/click comfort around interactive images (ON_IMAGE_CLICK). - Manage overflow with
disableScrollbar: keep it false when content may exceed bounds (e.g.,useRealSize).
Interactions & Events
ON_IMAGE_CLICK: open a larger image, navigate, or emit analytics.
Visibility & Authorization
- Enforce role/permission gating with
visibilityPolicySetId. - Suppress empty/broken states with
displayConditions(e.g., require non-emptyimageUrl). - Expose stable hooks for automation via
idanddataTestId.
Content & Localization
- Provide meaningful
altfor informative images; use emptyalt("") for decorative content. - Use
enableAsHotspotwith localizedguidedTourHotSpotTitleandguidedTourHotSpotDescriptionfor guided tours. - Keep
displayNamedescriptive for authoring clarity (non-user-facing).
Accessibility
- Text alternatives: define
alttext ascordingly. - For interactive images, align
altphrasing with theON_IMAGE_CLICKoutcome (e.g., “Opens larger view”). - Overflow access: set
disableScrollbar: falsewhen content may exceed bounds (e.g., withuseRealSize). - Aspect integrity: prefer
resizeImageStrategy: "fitToContainer"when distortion would harm comprehension. - Localization for guidance: when
enableAsHotspotis true, supply translatedguidedTourHotSpotTitle/guidedTourHotSpotDescription. - Prevent empty graphics from being announced by gating display with
displayConditionswhenimageUrlis missing. - Improve hit comfort on touch by adding
paddingClassaround clickable imageryalt – Defines alternative text description for the image. This text is read by screen readers and shown if the image fails to load.