Perform some API fixes on satya-dash's proposal

Author: fritz-c

README.md

@@ -92,7 +92,7 @@ nextSrcThumbnail    | string |                |          | Thumbnail image url c
 onCloseRequest      | func   |                |    yes   | Close window event. Should change the parent state such that the lightbox is not rendered
 onMovePrevRequest   | func   | empty function |          | Move to previous image event. Should change the parent state such that props.prevSrc becomes props.mainSrc, props.mainSrc becomes props.nextSrc, etc.
 onMoveNextRequest   | func   | empty function |          | Move to next image event. Should change the parent state such that props.nextSrc becomes props.mainSrc, props.mainSrc becomes props.prevSrc, etc.
-onLoadError         | func   | error object   |          | Will listen to the error if image is not loading
+onImageLoadError    | func   | empty function |          | Called when an image fails to load.<div>`(imageSrc: string, srcType: string, errorEvent: object): void`</div>
 discourageDownloads | bool   | `false`        |          | Enable download discouragement (prevents [right-click -> Save Image As...])
 animationDisabled   | bool   | `false`        |          | Disable all animation
 animationOnKeyInput | bool   | `false`        |          | Disable animation on actions performed with keyboard shortcuts

src/examples/cats/app.js

@@ -100,6 +100,9 @@ const App = React.createClass({
     movePrev() {
         this.setState({ index: (this.state.index + images.length - 1) % images.length });
     },
+    onImageLoadError(imageSrc, _srcType, errorEvent) {
+        console.error(`Could not load image at ${imageSrc}`, errorEvent);
+    },
     render() {
         let lightbox;
         if (this.state.isOpen) {
@@ -116,6 +119,7 @@ const App = React.createClass({
                     onCloseRequest={this.closeLightbox}
                     onMovePrevRequest={this.movePrev}
                     onMoveNextRequest={this.moveNext}
+                    onImageLoadError={this.onImageLoadError}
 
                     imageTitle={titles[this.state.index]}
                     imageCaption={captions[this.state.index]}

src/react-image-lightbox.js

@@ -705,21 +705,21 @@ class ReactImageLightbox extends Component {
     }
 
     // Load image from src and call callback with image width and height on load
-    loadImage(imageSrc, callback) {
+    loadImage(srcType, imageSrc, done) {
         // Return the image info if it is already cached
         if (this.isImageLoaded(imageSrc)) {
             setTimeout(() => {
-                callback(null, this.imageCache[imageSrc].width, this.imageCache[imageSrc].height);
+                done();
             }, 1);
             return;
         }
 
         const that = this;
         const inMemoryImage = new Image();
 
-        inMemoryImage.onerror = () => {
-            this.props.onLoadError(new Error('image load error'));
-            callback('image load error');
+        inMemoryImage.onerror = (errorEvent) => {
+            this.props.onImageLoadError(imageSrc, srcType, errorEvent);
+            done(errorEvent);
         };
 
         inMemoryImage.onload = function onLoad() {
@@ -729,20 +729,17 @@ class ReactImageLightbox extends Component {
                 height: this.height,
             };
 
-            callback(null, this.width, this.height);
+            done();
         };
 
         inMemoryImage.src = imageSrc;
     }
 
     // Load all images and their thumbnails
     loadAllImages(props = this.props) {
-        const generateImageLoadedCallback = (srcType, imageSrc) => (err) => {
+        const generateLoadDoneCallback = (srcType, imageSrc) => (err) => {
             // Give up showing image on error
             if (err) {
-                if (window.console) {
-                    window.console.warn(err);
-                }
                 return;
             }
 
@@ -762,7 +759,7 @@ class ReactImageLightbox extends Component {
 
             // Load unloaded images
             if (props[type] && !this.isImageLoaded(props[type])) {
-                this.loadImage(props[type], generateImageLoadedCallback(type, props[type]));
+                this.loadImage(type, props[type], generateLoadDoneCallback(type, props[type]));
             }
         });
     }
@@ -1237,8 +1234,9 @@ ReactImageLightbox.propTypes = {
     //  props.mainSrc becomes props.prevSrc, etc.
     onMoveNextRequest: PropTypes.func,
 
-    //Listener if any error occurs while loading the image
-    onLoadError: PropTypes.func,
+    // Called when an image fails to load
+    // (imageSrc: string, srcType: string, errorEvent: object): void
+    onImageLoadError: PropTypes.func,
 
     //-----------------------------
     // Download discouragement settings
@@ -1309,7 +1307,7 @@ ReactImageLightbox.propTypes = {
 ReactImageLightbox.defaultProps = {
     onMovePrevRequest: () => {},
     onMoveNextRequest: () => {},
-    onLoadError: () => {},
+    onImageLoadError:  () => {},
 
     discourageDownloads: false,