Basic usage
Add an image component to your UI Studio page to display visual content.
Best practices
- Optimize images to reduce file size without sacrificing quality. While Lucidworks does not make a specific recommendation, tools such as TinyPNG, ImageOptim, or your image editor’s “Save for Web” feature are available. The recommended maximum file size is 2MB for web display.
- If possible, configure a fallback image that displays if the primary image fails to load.
-
Use appropriate image formats for different content types:
- JPG: Photos and complex images
- PNG: Graphics with transparency or text
- SVG: Logos and icons to ensure correct scaling
- WebP: Modern format with better compression, if browser support allows
- Always provide meaningful Alt (alternative) text that conveys the purpose and content of the image. Screen readers rely on this to describe images to visually impaired users. Alt text also improves SEO and displays when images fail to load.
- Avoid using images of text for important content. Screen readers cannot read text embedded in images.
Configuration properties
URL to the image file.
Descriptive text for accessibility and SEO.Describe the image content and purpose. Avoid generic phrases like “image” or “photo”.
Clickthrough URL. When configured, clicking the image navigates to this URL.Examples:
https://www.example.com/productshttps://example.com/offers
Controls how the image fits within its container dimensions.
Corner roundness in pixels.
0= Square corners (default)4-8= Subtle rounded corners12-16= Noticeably rounded corners50+= Circular (when width equals height)
Optional backup image URL. Displays if the primary image fails to load.