Image List Item
The Alexa image list item responsive component (AlexaImageListItem
) displays an image along with text, formatted to display within a list. This component uses the AlexaImage
responsive component to size and format the item. Display a list of AlexaImageListItem
items with the AlexaImageList
responsive template.
Compatibility
AlexaImageListItem
is designed to work with all standard viewport profiles in the alexa-viewport-profiles
package:
- All hub round profiles
- All hub landscape profiles
- All hub portrait profiles
- All mobile profiles
- All TV profiles
If you use AlexaImageListItem
on an unsupported viewport, you might have unexpected results. For details about viewport profiles, see Viewport Profiles.
Import the alexa-layouts package
To use AlexaImageListItem
, import the alexa-layouts package.
The latest version of the alexa-layouts
package is 1.7.0. AlexaImageListItem
was introduced in version 1.1.0.
AlexaImageListItem parameters
All parameters except type
are optional.
Name | Type | Default | Description | Widget support | Version added |
---|---|---|---|---|---|
|
String |
" |
A string describing the list item. Voice over reads this string when the user selects the item. |
Not supported |
1.4.0 |
|
String |
|
The image and text content direction. Set to |
Not supported |
1.4.0 |
|
String |
URI a default image to use when |
Not supported |
1.1.0 | |
|
Any |
|
The graphic to display to represent an 'empty' rating slot (such as an empty star). Used when |
Not supported |
1.2.0 |
|
Array |
— |
Array of entity data to bind to this component. |
Not supported |
1.2.0 |
|
Any |
|
The graphic to display to represent a 'full' rating slot (such as a full star). Used when |
Not supported |
1.2.0 |
|
Any |
|
The graphic to display to represent a 'half' rating slot (such as a half star). Used when |
Not supported |
1.2.0 |
|
Boolean |
|
When |
Not supported |
1.2.0 |
|
Boolean |
|
Toggle to hide the divider that appears at the bottom/right of each 'Horizontal Item Lockup' item to help separate it from the next content. Default to |
Not supported |
1.6.0 |
|
Boolean |
|
When |
Not supported |
1.1.0 |
|
String |
|
Determines how to position the image within the bounding box. Used when the image is smaller than the bounding box. Options are bottom, bottom-left, bottom-right, center, left, right, top, top-left, top-right. This property works the same as the |
Not supported |
1.1.0 |
|
String |
— |
Alternate text for the image. Voice over reads this string. |
Not supported |
1.4.0 |
|
String |
|
Aspect ratio to use for the image bounding box for the item. Options are square, round, standard_landscape, standard_portrait, poster_landscape, poster_portrait, widescreen. This property works the same as the |
Not supported |
1.1.0 |
|
Boolean |
|
When |
Not supported |
1.1.0 |
|
— |
Height of the image bounding box for the image. The image is scaled to fit within this height using the |
Not supported |
1.2.0 | |
|
Boolean |
|
When |
Not supported |
1.1.0 |
|
Boolean |
|
When |
Not supported |
1.1.0 |
|
Number |
0 |
When set to a number from 1 to 100, display a progress bar on the image based on the provided percentage. This gives the user a glanceable status for the item. The progress bar displays when |
Not supported |
1.1.0 |
|
Boolean |
|
When |
Not supported |
1.1.0 |
|
String |
|
Determines how to scale the image to fit within the bounding box. Options are none, fill, best-fit, best-fill, best-fit-down. This property works the same as the |
Not supported |
1.1.0 |
|
Boolean |
|
When |
Not supported |
1.3.0 |
|
Boolean |
|
Toggle to display the progress bar on the image overlay. The progress bar displays when |
Not supported |
1.1.0 |
|
String |
URI for the image to display. |
Not supported |
1.1.0 | |
|
String |
|
Specifies the layout direction for the content. Set this property to either |
Not supported |
1.4.0 |
|
The action to trigger when the user selects the list item. |
Not supported |
1.1.0 | ||
|
String |
Primary text to display for the list item. |
Not supported |
1.1.0 | |
|
String |
Provider text to display over the image. |
Not supported |
1.1.0 | |
|
String |
|
The type of graphic to use for the rating. Set to |
Not supported |
1.2.0 |
|
Number |
— |
The numeric rating between 0 and 5. Used when |
Not supported |
1.2.0 |
|
String |
— |
Determines whether to display a single graphical asset for the rating, or build the rating from multiple image assets. When set to |
Not supported |
1.2.0 |
|
String |
— |
Text to display next to the rating. |
Not supported |
1.2.0 |
|
String |
Secondary text for the list item. |
Not supported |
1.1.0 | |
|
Any |
— |
The graphic to display to represent the rating. Used when |
Not supported |
1.2.0 |
|
— |
The width of the bounding box for the single graphic that represents the rating. Used when |
Not supported |
1.2.0 | |
|
Any |
— |
Content to speak with the |
Not supported |
1.2.0 |
|
String |
Tertiary text for the list item. |
Not supported |
1.1.0 | |
|
String |
|
Set the dark or light color theme. The selected theme controls the colors used for the component. |
Not supported |
1.1.0 |
Image size, aspect ratio, and scaling
The AlexaImageListItem
responsive component uses a pre-defined height and width, determined by the imageAspectRatio
you provide and the characteristics of the viewport.
The aspect ratio, scaling, and alignment work the same way they do for the AlexaImage
responsive component. For details, see Image aspect ratios and scaling examples.
AlexaImageListItem example
The following example illustrates an AlexaImageListItem
with all text options, the progress bar, and rating.
Related topics
- Alexa Design System Overview
- Responsive Components and Templates
- AlexaImageList
- AlexaPaginatedList
- AlexaLists
Last updated: Nov 28, 2023