@@ -39,44 +39,19 @@ function generateRequestId() {
3939}
4040
4141/**
42- * <Image> - A react component for displaying different types of images,
42+ * A React component for displaying different types of images,
4343 * including network images, static resources, temporary local images, and
44- * images from local disk, such as the camera roll. Example usage:
44+ * images from local disk, such as the camera roll.
4545 *
46- * renderImages: function() {
47- * return (
48- * <View>
49- * <Image
50- * style={styles.icon}
51- * source={require('./myIcon.png')}
52- * />
53- * <Image
54- * style={styles.logo}
55- * source={{uri: 'https://facebook.github.io/react-native/img/opengraph.png'}}
56- * />
57- * </View>
58- * );
59- * },
60- *
61- * More example code in ImageExample.js
46+ * See https://facebook.github.io/react-native/docs/image.html
6247 */
63-
6448var Image = createReactClass ( {
6549 displayName : 'Image' ,
6650 propTypes : {
6751 ...ViewPropTypes ,
6852 style : StyleSheetPropType ( ImageStylePropTypes ) ,
6953 /**
70- * `uri` is a string representing the resource identifier for the image, which
71- * could be an http address, a local file path, or a static image
72- * resource (which should be wrapped in the `require('./path/to/image.png')` function).
73- *
74- * `headers` is an object representing the HTTP headers to send along with the request
75- * for a remote image.
76- *
77- * This prop can also contain several remote `uri`, specified together with
78- * their width and height. The native side will then choose the best `uri` to display
79- * based on the measured size of the image container.
54+ * See https://facebook.github.io/react-native/docs/image.html#source
8055 */
8156 source : PropTypes . oneOfType ( [
8257 PropTypes . shape ( {
@@ -97,12 +72,12 @@ var Image = createReactClass({
9772 ] ) ,
9873 /**
9974 * blurRadius: the blur radius of the blur filter added to the image
75+ *
76+ * See https://facebook.github.io/react-native/docs/image.html#blurradius
10077 */
10178 blurRadius : PropTypes . number ,
10279 /**
103- * similarly to `source`, this property represents the resource used to render
104- * the loading indicator for the image, displayed until image is ready to be
105- * displayed, typically after when it got downloaded from network.
80+ * See https://facebook.github.io/react-native/docs/image.html#loadingindicatorsource
10681 */
10782 loadingIndicatorSource : PropTypes . oneOfType ( [
10883 PropTypes . shape ( {
@@ -137,40 +112,14 @@ var Image = createReactClass({
137112 * The mechanism that should be used to resize the image when the image's dimensions
138113 * differ from the image view's dimensions. Defaults to `auto`.
139114 *
140- * - `auto`: Use heuristics to pick between `resize` and `scale`.
141- *
142- * - `resize`: A software operation which changes the encoded image in memory before it
143- * gets decoded. This should be used instead of `scale` when the image is much larger
144- * than the view.
145- *
146- * - `scale`: The image gets drawn downscaled or upscaled. Compared to `resize`, `scale` is
147- * faster (usually hardware accelerated) and produces higher quality images. This
148- * should be used if the image is smaller than the view. It should also be used if the
149- * image is slightly bigger than the view.
150- *
151- * More details about `resize` and `scale` can be found at http://frescolib.org/docs/resizing-rotating.html.
152- *
153- * @platform android
115+ * See https://facebook.github.io/react-native/docs/image.html#resizemethod
154116 */
155117 resizeMethod : PropTypes . oneOf ( [ 'auto' , 'resize' , 'scale' ] ) ,
156118 /**
157119 * Determines how to resize the image when the frame doesn't match the raw
158120 * image dimensions.
159121 *
160- * 'cover': Scale the image uniformly (maintain the image's aspect ratio)
161- * so that both dimensions (width and height) of the image will be equal
162- * to or larger than the corresponding dimension of the view (minus padding).
163- *
164- * 'contain': Scale the image uniformly (maintain the image's aspect ratio)
165- * so that both dimensions (width and height) of the image will be equal to
166- * or less than the corresponding dimension of the view (minus padding).
167- *
168- * 'stretch': Scale width and height independently, This may change the
169- * aspect ratio of the src.
170- *
171- * 'center': Scale the image down so that it is completely visible,
172- * if bigger than the area of the view.
173- * The image will not be scaled up.
122+ * See https://facebook.github.io/react-native/docs/image.html#resizemode
174123 */
175124 resizeMode : PropTypes . oneOf ( [ 'cover' , 'contain' , 'stretch' , 'center' ] ) ,
176125 } ,
@@ -198,6 +147,8 @@ var Image = createReactClass({
198147 /**
199148 * Prefetches a remote image for later use by downloading it to the disk
200149 * cache
150+ *
151+ * See https://facebook.github.io/react-native/docs/image.html#prefetch
201152 */
202153 prefetch ( url : string , callback : ?Function ) {
203154 const requestId = generateRequestId ( ) ;
@@ -206,7 +157,9 @@ var Image = createReactClass({
206157 } ,
207158
208159 /**
209- * Abort prefetch request
160+ * Abort prefetch request.
161+ *
162+ * See https://facebook.github.io/react-native/docs/image.html#abortprefetch
210163 */
211164 abortPrefetch ( requestId : number ) {
212165 ImageLoader . abortRequest ( requestId ) ;
@@ -215,9 +168,7 @@ var Image = createReactClass({
215168 /**
216169 * Perform cache interrogation.
217170 *
218- * @param urls the list of image URLs to check the cache for.
219- * @return a mapping from url to cache status, such as "disk" or "memory". If a requested URL is
220- * not in the mapping, it means it's not in the cache.
171+ * See https://facebook.github.io/react-native/docs/image.html#querycache
221172 */
222173 async queryCache (
223174 urls : Array < string > ,
@@ -226,9 +177,9 @@ var Image = createReactClass({
226177 } ,
227178
228179 /**
229- * Resolves an asset reference into an object which has the properties `uri`, `width`,
230- * and `height`. The input may either be a number (opaque type returned by
231- * require('./foo.png')) or an `ImageSource` like { uri: '<http location || file path>' }
180+ * Resolves an asset reference into an object.
181+ *
182+ * See https://facebook.github.io/react-native/docs/image.html#resolveassetsource
232183 */
233184 resolveAssetSource : resolveAssetSource ,
234185 } ,
0 commit comments