Vega Image Component
Overview
The Vega Image component lets you display images in your Front-End modules. With this component, you can specify image dimensions, alternate text, or apply a custom CSS class. Use this component by specifying the URL of external image files, or image files stored in Managed Assets.
You can find the Vega Image component under the Display & Layout group to the left of the Module Builder.
About the Configuration Window
To learn more about general component settings, view our General Component Settings article.
Display Panel
Source
|
Setting |
Description |
|---|---|
|
URL |
Enter the URL address of the image. For images stored in Managed Assets, enter the following: {{data.getEnv.REMOTE_ROOT}}assets/[filePathAndName.jpg]. Replace [filePathAndName.jpg] with the folder path and image file. For example, {{data.getEnv.REMOTE_ROOT}}assets/application1/exampleLogo.jpg Supported image formats include:
Unsupported images formats do not display, but can still be accessed using UNQENG.tools.getComponentState('propertyId')
|
|
Alternative Text |
Provide a simple description of the image. Screen Readers produce an audio description of the alternate text when they reach the image. |
Default State Options
|
Setting |
Description |
|---|---|
|
Hidden |
Shows or hides the component from view. Setting the Hidden toggle to (ON) hides the component in By default, the Hidden toggle is set to (OFF). |
Display Settings
|
Setting |
Description |
|---|---|
|
Width |
The width of the image in pixels. Leave this field blank to use the image's original width. |
|
Height |
The height of the image in pixels. Leave this field blank to use the image's original height. |
Advanced Panel
Additional Styling
|
Setting |
Description |
|---|---|
|
Custom CSS Class |
Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name. |
Adding an Image Component
To use an Image component, you must have a URL address for an image. For this example, use the following image URL: https://docs.unqork.io/Content/Resources/Images/exampleLogo.jpg.
Configure the Image Component
| 1. | In the Module Builder, drag and drop an Image component onto the canvas. |
| 2. | In the Property ID field, enter imageLogo. |
| 3. | In the URL field, enter https://docs.unqork.io/Content/Resources/Images/exampleLogo.jpg. |
| 4. | In the Alternative Textfield, enter A static image displaying the company logo.. |
| 5. | Click Save & Close. |
Preview your module in Express View. The image displays at its original size.
Inspect the image using your browser's DevTools to display the Alternate Text value in the alt attribute.
Structure of an Image Component's Data
Using the example above, execute the Vega Console command UNQENG.tools.getComponentState('imageLogo') in the DevTools Console to display the component's data structure:
Resources
