react-image-lightbox - npm Package Compare versions

Comparing version 3.2.2 to 3.3.0

package.json

 {
   "name": "react-image-lightbox",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "A lightbox component for React.js",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -87,10 +87,11 @@ # React Image Lightbox
 mainSrc             | string |                |    yes   | Main display image url
-prevSrc             | string |                |          | Previous display image url (displayed to the left). If left undefined, movePrev actions will not be performed, and the button not displayed
-nextSrc             | string |                |          | Next display image url (displayed to the right). If left undefined, moveNext actions will not be performed, and the button not displayed
-mainSrcThumbnail    | string |                |          | Thumbnail image url corresponding to props.mainSrc
-prevSrcThumbnail    | string |                |          | Thumbnail image url corresponding to props.prevSrc
-nextSrcThumbnail    | string |                |          | Thumbnail image url corresponding to props.nextSrc
+prevSrc             | string |                |          | Previous display image url (displayed to the left). If left undefined, `onMovePrevRequest` will not be called, and the button not displayed
+nextSrc             | string |                |          | Next display image url (displayed to the right). If left undefined, `onMoveNextRequest` will not be called, and the button not displayed
+mainSrcThumbnail    | string |                |          | Thumbnail image url corresponding to `props.mainSrc`
+prevSrcThumbnail    | string |                |          | Thumbnail image url corresponding to `props.prevSrc`
+nextSrcThumbnail    | string |                |          | Thumbnail image url corresponding to `props.nextSrc`
 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.
+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.
+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...])
@@ -105,3 +106,3 @@ animationDisabled   | bool   | `false`        |          | Disable all animation
 toolbarButtons      | node[] |                |          | Array of custom toolbar buttons
-reactModalStyle     | Object | `{}`           |          | Set z-index style, etc., for the parent react-modal (format: https://github.com/reactjs/react-modal#styles )
+reactModalStyle     | Object | `{}`           |          | Set `z-index` style, etc., for the parent react-modal ([react-modal style format](https://github.com/reactjs/react-modal#styles))
 imagePadding        | number | `10`           |          | Padding (px) between the edge of the window and the lightbox
@@ -113,9 +114,9 @@ clickOutsideToClose | bool   | `true`         |          | When true, clicks outside of the image close the lightbox
 
-| Browser | Works? |
-|:-----|:-----|
-| Chrome | Yes |
-| Firefox | Yes |
-| Safari | Yes |
-| IE >= 10 | Yes |
-| IE 9 | Everything works, but no animations |
+| Browser  | Works?                              |
+|:---------|:------------------------------------|
+| Chrome   | Yes                                 |
+| Firefox  | Yes                                 |
+| Safari   | Yes                                 |
+| IE >= 10 | Yes                                 |
+| IE 9     | Everything works, but no animations |
 
@@ -122,0 +123,0 @@ ## Contributing

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

291467

increased by0.18%

Lines of code

1279

increased by0.24%

Number of lines in readme file

143

increased by0.7%

No dependency changes