Edit

Image

A React component for displaying different types of images, including network images, static resources, temporary local images, and images from local disk, such as the camera roll.

Example usage:

renderImages: function() {
  return (
    <View>
      <Image
        style={styles.icon}
        source={require('./myIcon.png')}
      />
      <Image
        style={styles.logo}
        source={{uri: 'http://facebook.github.io/react/assets/logo_og.png'}}
      />
    </View>
  );
},

Props

• testID
• onLayout
• onLoadEnd
• onLoadStart
• resizeMode
• source
• style
• onLoad
• accessibilityLabel
• accessible
• blurRadius
• capInsets
• defaultSource
• onError
• onProgress

Methods

• getSize

---

Reference

Props

testID

A unique identifier for this element to be used in UI Automation testing scripts.

Type	Required
string	No

---

onLayout

Invoked on mount and layout changes with {nativeEvent: {layout: {x, y, width, height}}}.

Type	Required
function	No

---

onLoadEnd

Invoked when load either succeeds or fails

Type	Required
function	No

---

onLoadStart

Invoked on load start

Type	Required
function	No

---

resizeMode

Determines how to resize the image when the frame doesn't match the raw image dimensions.

'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).

'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).

'stretch': Scale width and height independently, This may change the aspect ratio of the src.

Type	Required
enum('cover', 'contain', 'stretch')	No

---

source

uri is a string representing the resource identifier for the image, which could be an http address, a local file path, or the name of a static image resource (which should be wrapped in the require('./path/to/image.png') function).

Type	Required
object: {uri: string}, ,number	No

---

style

Type	Required
style	No

• Layout Props...

• Shadow Props...

• Transforms...

• backfaceVisibility: enum('visible', 'hidden')

• backgroundColor: color

• borderColor: color

• borderRadius: number

• borderWidth: number

• opacity: number

• overflow: enum('visible', 'hidden')

• resizeMode: Object.keys(ImageResizeMode)

• overlayColor: string (Android)

  When the image has rounded corners, specifying an overlayColor will cause the remaining space in the corners to be filled with a solid color. This is useful in cases which are not supported by the Android implementation of rounded corners:

  • Certain resize modes, such as 'contain'
  • Animated GIFs

  A typical way to use this prop is with images displayed on a solid background and setting the overlayColor to the same color as the background.

  For details of how this works under the hood, see http://frescolib.org/rounded-corners-and-circles.md

• tintColor: color (iOS)

  iOS-Specific style to "tint" an image. Changes the color of all the non-transparent pixels to the tintColor.

---

onLoad

Invoked when load completes successfully

Type	Required
function	No

---

accessibilityLabel

The text that's read by the screen reader when the user interacts with the image.

Type	Required	Platform
string	No	iOS

---

accessible

When true, indicates the image is an accessibility element.

Type	Required	Platform
bool	No	iOS

---

blurRadius

blurRadius: the blur radius of the blur filter added to the image

Type	Required	Platform
number	No	iOS

---

capInsets

When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation

Type	Required	Platform
object: {top: number, left: number, bottom: number, right: number}	No	iOS

---

defaultSource

A static image to display while loading the image source.

Type	Required	Platform
object: {uri: string}, ,number	No	iOS

---

onError

Invoked on load error with {nativeEvent: {error}}

Type	Required	Platform
function	No	iOS

---

onProgress

Invoked on download progress with {nativeEvent: {loaded, total}}

Type	Required	Platform
function	No	iOS

Methods

getSize()

static getSize(uri: string, success: function, failure: function)

Retrieve the width and height (in pixels) of an image prior to displaying it. This method can fail if the image cannot be found, or fails to download.

In order to retrieve the image dimensions, the image may first need to be loaded or downloaded, after which it will be cached. This means that in principle you could use this method to preload images, however it is not optimized for that purpose, and may in future be implemented in a way that does not fully load/download the image data. A proper, supported way to preload images will be provided as a separate API.