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('image!myIcon')}
      />
      <Image
        style={styles.logo}
        source={{uri: 'https://reactjs.org/logo-og.png'}}
      />
    </View>
  );
},

Props

• onLoadProgress
• accessibilityLabel
• capInsets
• defaultSource
• onLayout
• onLoadAbort
• onLoadError
• accessible
• onLoadStart
• onLoaded
• resizeMode
• source
• style
• testID

---

Reference

Props

onLoadProgress

Invoked on download progress with

{nativeEvent: { written, total}}.

Type	Required
function	No

---

accessibilityLabel

Custom string to display for accessibility.

Type	Required
string	No

---

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
object: {top: number, left: number, bottom: number, right: number}	No

---

defaultSource

A static image to display while downloading the final image off the network.

Type	Required
object: {uri: string}	No

---

onLayout

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

Type	Required
function	No

---

onLoadAbort

Invoked on load abort

Type	Required
function	No

---

onLoadError

Invoked on load error

{nativeEvent: { error}}.

Type	Required
function	No

---

accessible

Whether this element should be revealed as an accessible element.

Type	Required
bool	No

---

onLoadStart

Invoked on load start

Type	Required
function	No

---

onLoaded

Invoked on load end

Type	Required
function	No

---

resizeMode

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

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('image!name') function).

Type	Required
object: {uri: string}	No

---

style

Type	Required
style	No

• Layout Props...

• Transforms...

• backgroundColor: string

• borderColor: string

• borderRadius: number

• borderWidth: number

• opacity: number

• resizeMode: Object.keys(ImageResizeMode)

• tintColor: string

---

testID

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

Type	Required
string	No