From f4f8048d45ed15c0b3fb9154ff87635677fd2fe5 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Wed, 21 Sep 2016 20:38:29 +0000 Subject: [PATCH] Updated docs for next --- releases/next/docs/image.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/releases/next/docs/image.html b/releases/next/docs/image.html index e9012532348..90209e3dd10 100644 --- a/releases/next/docs/image.html +++ b/releases/next/docs/image.html @@ -109,7 +109,9 @@ rounded buttons, shadows, and other resizable assets. More info in the should be either a local file path or the name of a static image resource (which should be wrapped in the require('./path/to/image.png') function).
  • width, height - can be specified if known at build time, in which case these will be used to set the default <Image/> component dimensions.
  • scale - used to indicate the scale factor of the image. Defaults to 1.0 if -unspecified, meaning that one image pixel equates to one display point / DIP.
  • number - Opaque type returned by something like require('./image.jpg').

    • iosonError PropTypes.func #

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

    iosonProgress PropTypes.func #

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

    Methods #

    static getSize(uri, success, failure): #

    Retrieve the width and height (in pixels) of an image prior to displaying it. +unspecified, meaning that one image pixel equates to one display point / DIP.

  • number - Opaque type returned by something like require('./image.jpg').

    • iosonError PropTypes.func #

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

    iosonPartialLoad PropTypes.func #

    Invoked when a partial load of the image is complete. The definition of +what constitutes a "partial load" is loader specific though this is meant +for progressive JPEG loads.

    iosonProgress PropTypes.func #

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

    Methods #

    static getSize(uri, success, failure): #

    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