Used to display images

#Attributes

#auto-size

// @defaultValue: false
'auto-size'?: boolean;

When set to true and the <image> element has no width or height, the size of the <image> will be automatically adjusted to match the image's original dimensions after the image is successfully loaded, ensuring that the aspect ratio is maintained.

#autoplay

// @defaultValue: true
autoplay?: boolean;

Specifies whether the animated image should start playing automatically once it is loaded.

#blur-radius

'blur-radius'?: string;

Image blur radius

#cap-insets

'cap-insets'?: string;

Stretchable area for 9patch images, in percentage or decimal, four values for top, right, bottom, left

#cap-insets-scale

// @defaultValue: 1
'cap-insets-scale'?: number;

Adjust the scale of stretchable area for 9patch images

#defer-src-invalidation

// @defaultValue: false
'defer-src-invalidation'?: boolean;

When set to true, the <image> will only clear the previously displayed image resource after a new image has successfully loaded. The default behavior is to clear the image resource before starting a new load. This can resolve flickering issues when the image src is switched and reloaded. It is not recommended to enable this in scenarios where there is node reuse in views like lists.

#image-config

// @defaultValue: "ARGB_8888"
'image-config'?: 'ARGB_8888' | 'RGB_565';

ARGB_8888 : 32-bit memory per pixel, supports semi-transparent images.

RGB_565 : 16-bit memory per pixel, reduces memory usage but loses transparency.

Support PC platform since 3.5

#loop-count

// @defaultValue: 0
'loop-count'?: number;

Number of times an animated image plays, 0 stands for infinite

#mode

// @defaultValue: 'scaleToFill'
mode?: 'scaleToFill' | 'aspectFit' | 'aspectFill' | 'center';

Specifies image cropping/scaling mode

scaleToFill : Scales the image without preserving the aspect ratio, stretching the image to fill the element.

aspectFit : Scales the image while preserving aspect ratio so that the long side is fully visible.

aspectFill : Scales the image while preserving aspect ratio, ensuring the short side fills the element.

center : Does not scale the image; image is centered.

#placeholder

placeholder?: string;

Placeholder image, used same as src

#prefetch-height

// @defaultValue: "0px"
'prefetch-height'?: string;

Image won't load if its size is 0, but will load if prefetch-height is set

#prefetch-width

// @defaultValue: "0px"
'prefetch-width'?: string;

Image won't load if its size is 0, but will load if prefetch-width is set

#src

// @defaultValue: undefined
src?: string;

Supports http/https/base64

#tint-color

'tint-color'?: string;

Changes the color of all non-transparent pixels to the tint-color specified. The value is a <color> .

#Events

Frontend can bind corresponding event callbacks to listen for runtime behaviors of the element, as shown below.

#bindcurrentloopcomplete

bindcurrentloopcomplete = (e: BaseEvent) => {};

Triggered when one loop of the animated image finishes playing.

#binderror

binderror = (e: ErrorEvent) => {};

Image load error event

#bindfinalloopcomplete

bindfinalloopcomplete = (e: BaseEvent) => {};

Triggered when the animated image finishes playing all loop-count loops. If loop-count is not set, this callback will not be triggered.

#bindload

bindload = (e: LoadEvent) => {};

Image load success event

#bindstartplay

bindstartplay = (e: BaseEvent) => {};

Triggered when the animated image starts playing.

#Methods

Frontend can invoke component methods via the SelectorQuery API.

#pauseAnimation

lynx.createSelectorQuery()
     .select('#id')
     .invoke({
      method: 'pauseAnimation',
      success: function (res) {},
      fail: function (res) {},
    })
    .exec();

Pauses the animation, without resetting the loop-count.

#resumeAnimation

lynx.createSelectorQuery()
     .select('#id')
     .invoke({
      method: 'resumeAnimation',
      success: function (res) {},
      fail: function (res) {},
    })
    .exec();

Resumes the animation, without resetting the loop-count.

#startAnimate

lynx.createSelectorQuery()
     .select('#id')
     .invoke({
      method: 'startAnimate',
      success: function (res) {},
      fail: function (res) {},
    })
    .exec();

Restart the animation playback method controlled by the front end, and the animation playback progress and loop count will be reset.

#stopAnimation

lynx.createSelectorQuery()
     .select('#id')
     .invoke({
      method: 'stopAnimation',
      success: function (res) {},
      fail: function (res) {},
    })
    .exec();

Stops the animation, and it will reset the loop-count.