Image

Image widget

The Image Widget allows you to render images from a URL or local assets.

You can manage your assets using Ensemble Studio. See how

Test in Kitchen Sink (opens in a new tab)

Properties

PropertyTypeDescription
sourcestringURL to or asset name of the image. If the URL is used, it is highly recommended that the dimensions is set (either with width/height or other means) to prevent the UI jerkiness while loading.
onTapactionCall Ensemble's built-in functions or execute code
onTapHapticenumThe type of haptic to perform when image is pressed. It should be one of heavyImpact, mediumImpact, lightImpact, selectionClick, and vibrate
stylesobjectSee properties

styles

PropertyTypeDescription
expandedbooleanIf the parent is a Row or Column, this flag will stretch this widget in the appropriate direction. (e.g. stretch horizontally for parent of type Row)
visiblebooleanToggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified.
elevationintegerThe z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. Minimum value: 0, Maximum value: 24
elevationShadowColorinteger or stringThe shadow color for the elevation, which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. transparent black blue white red grey teal amber pink purple yellow green brown cyan indigo lime orange
elevationBorderRadiusstring or integerThe border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
alignmentstringThe alignment of the widget relative to its parent topLeft, topCenter, topRight, centerLeft, center, centerRight, bottomLeft, bottomCenter, bottomRight.
borderRadiusstring or integerThe border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
borderColorinteger or stringSets the border color, starting with '0xFF' for full opacity. transparent black blue white red grey teal amber pink purple yellow green brown cyan indigo lime orange
borderWidthintegerThickness of the border. Minimum value should be 0.
shadowColorinteger or stringSets the box shadow color starting with '0xFF' for full opacity. transparent black blue white red grey teal amber pink purple yellow green brown cyan indigo lime orange
shadowOffsetarrayThe values in array define the horizontal and vertical offset of the shadow. Example: if the shadowOffset is set to [2, 4], the shadow will be offset by 2 pixels horizontally and 4 pixels vertically from its original position.
shadowRadiusstring or integerThe border radius of the widget.This can be specified using CSS-like notation with 1 to 4 integers. Minimum value: 0.
shadowStylestringThe blur style to apply on the shadow normal, solid, outer, inner
stackPositionTopintegerThe distance of the child's top edge from the top of the stack. This is applicable only for Stack's children.
stackPositionBottomintegerThe distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children.
stackPositionLeftintegerThe distance that the child's left edge from the left of the stack. This is applicable only for Stack's children.
stackPositionRightintegerThe distance that the child's right edge from the right of the stack. This is applicable only for Stack's children.
captureWebPointerbooleanApplicable for Web only. When overlaying widgets on top of certain HTML container (e.g. Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget.
marginstring or integerMargin with CSS-style notation
paddingstring or integerPadding with CSS-style value
backgroundImageobjectBackground image of the box. see properties
backgroundGradientobjectBackground gradient of the box see properties
backgroundColorinteger or stringBackground color of the box. which can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'. transparent black blue white red grey teal amber pink purple yellow green brown cyan indigo lime orange
widthintegerThe width property determines the horizontal size of an element, allowing control over its width dimension within the layout.
heightintegerThe height property determines the vertical size of an element, allowing control over its height dimension within the layout.
fitstringHow to fit the image within our width/height or our parent (if dimension is not specified) fill, contain, cover, fitHeight, fitWidth, none, scaleDown
resizedWidthintegerImages will be automatically resized (default to 800 width with no height set) before rendering. If you know the rough image width, set this number to be the same or a slightly larger width to optimize the loading time. To maintain the original aspect ratio, set either resizedWidth or resizedHeight, but not both. This setting is not supported on Web.
resizedHeightintegerImages will be automatically resized (default to 800 width with no height set) before rendering. If you know the rough image height, set this number to be the same or a slightly larger height to optimize the loading time. To maintain the original aspect ratio, set either resizedWidth or resizedHeight, but not both. This setting is not supported on Web.
visibilityTransitionDurationintegerSpecify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible.
placeholderColorinteger or stringThe placeholder color while the image is loading transparent black blue white red grey teal amber pink purple yellow green brown cyan indigo lime orange

styles.backgroundGradient

PropertyTypeDescription
colorsarrayThe list of colors used for the gradient. Colors can be represented in different formats. It can be specified as a number, a predefined color name, or a hexadecimal value starting with '0x'.
startstringThe starting position of the gradient
endstringThe ending position of the gradient

styles.backgroundImage

PropertyTypeDescription
sourcestringThe Image URL to fill the background
fitstringHow to fit the image within our width/height or our parent (if dimension is not specified) . see options
alignmentstringAlignment of the background image

Fit options for styles.backgroundImage

OptionDescription
fillStretch our image to fill the dimension, and distorting the aspect ratio if needed
containScale the image such that the entire image is contained within our dimension
coverScale the image to fill our dimension, clipping the image as needed
fitWidthScale the image to fit the width, and clipping the height if needed
fitHeightScale the image to fit the height, and clipping the width if needed
noneCenter-Align the original image size, clipping the content if needed
scaleDownCenter-Align the image and only scale down to fit. Image will not be scaled up to bigger dimension.