);
}
}
```
## Options
Property | Type | Default | Required | Description
:---------------------------|:------:|:--------------:|:--------:|:----------------------------------------
mainSrc | string | | yes | Main display image url
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`. Displayed as a placeholder while the full-sized image loads.
prevSrcThumbnail | string | | | Thumbnail image url corresponding to `props.prevSrc`. Displayed as a placeholder while the full-sized image loads.
nextSrcThumbnail | string | | | Thumbnail image url corresponding to `props.nextSrc`. Displayed as a placeholder while the full-sized image loads.
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.
onImageLoadError | func | empty function | | Called when an image fails to load.
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
animationDuration | number | `300` | | Animation duration (ms)
keyRepeatLimit | number | `180` | | Required interval of time (ms) between key actions (prevents excessively fast navigation of images)
keyRepeatKeyupBonus | number | `40` | | Amount of time (ms) restored after each keyup (makes rapid key presses slightly faster than holding down the key to navigate images)
imageTitle | node | | | Image title (Descriptive element above image)
imageCaption | node | | | Image caption (Descriptive element below image), accepts a string or an an array of strings
toolbarButtons | node[] | | | Array of custom toolbar buttons
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
clickOutsideToClose | bool | `true` | | When true, clicks outside of the image close the lightbox
enableZoom | bool | `true` | | Set to false to disable zoom functionality and hide zoom buttons
customToolbarStyle | Object | | | Style the top toolbar containing the title, zoom and close buttons
customToolbarTextStyle | Object | | | Style the top toolbar title container
customToolbarButtonsStyle | Object | | | Style the top toolbar zoom and close buttons container
customCaptionBarStyle | Object | | | Style the bottom caption bar
customCaptionTextStyle | Object | | | Style the bottom caption bar text container
## Browser Compatibility
| Browser | Works? |
|:---------|:------------------------------------|
| Chrome | Yes |
| Firefox | Yes |
| Safari | Yes |
| IE >= 10 | Yes |
## Contributing
After cloning the repository and running `npm install` inside, you can use the following commands to develop and build the project.
```sh
# Starts a webpack dev server that hosts a demo page with the lightbox.
# It uses react-hot-loader so changes are reflected on save.
npm start
# Lints the code with eslint and my custom rules.
npm run lint
# Lints and builds the code, placing the result in the dist directory.
# This build is necessary to reflect changes if you're
# `npm link`-ed to this repository from another local project.
npm run build
```
Pull requests are welcome!
## License
MIT
---
_Source: https://npm.io/package/react-image-lightbox-expansion · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._