Skip to content
This repository was archived by the owner on Jan 19, 2023. It is now read-only.

Commit 96b1612

Browse files
committed
Clean up README
1 parent b37f2cb commit 96b1612

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -84,14 +84,14 @@ All unprefixed classes (listed below) will be removed in v4.0.0. Use their `ril-
8484
Property | Type | Default | Required | Description
8585
:-------------------|:------:|:--------------:|:--------:|:----------------------------------------
8686
mainSrc | string | | yes | Main display image url
87-
prevSrc | string | | | Previous display image url (displayed to the left). If left undefined, movePrev actions will not be performed, and the button not displayed
88-
nextSrc | string | | | Next display image url (displayed to the right). If left undefined, moveNext actions will not be performed, and the button not displayed
89-
mainSrcThumbnail | string | | | Thumbnail image url corresponding to props.mainSrc
90-
prevSrcThumbnail | string | | | Thumbnail image url corresponding to props.prevSrc
91-
nextSrcThumbnail | string | | | Thumbnail image url corresponding to props.nextSrc
87+
prevSrc | string | | | Previous display image url (displayed to the left). If left undefined, `onMovePrevRequest` will not be called, and the button not displayed
88+
nextSrc | string | | | Next display image url (displayed to the right). If left undefined, `onMoveNextRequest` will not be called, and the button not displayed
89+
mainSrcThumbnail | string | | | Thumbnail image url corresponding to `props.mainSrc`
90+
prevSrcThumbnail | string | | | Thumbnail image url corresponding to `props.prevSrc`
91+
nextSrcThumbnail | string | | | Thumbnail image url corresponding to `props.nextSrc`
9292
onCloseRequest | func | | yes | Close window event. Should change the parent state such that the lightbox is not rendered
93-
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.
94-
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.
93+
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.
94+
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.
9595
onImageLoadError | func | empty function | | Called when an image fails to load.<div>`(imageSrc: string, srcType: string, errorEvent: object): void`</div>
9696
discourageDownloads | bool | `false` | | Enable download discouragement (prevents [right-click -> Save Image As...])
9797
animationDisabled | bool | `false` | | Disable all animation
@@ -102,20 +102,20 @@ keyRepeatKeyupBonus | number | `40` | | Amount of time (ms) r
102102
imageTitle | node | | | Image title (Descriptive element above image)
103103
imageCaption | node | | | Image caption (Descriptive element below image)
104104
toolbarButtons | node[] | | | Array of custom toolbar buttons
105-
reactModalStyle | Object | `{}` | | Set z-index style, etc., for the parent react-modal (format: https://github.com/reactjs/react-modal#styles )
105+
reactModalStyle | Object | `{}` | | Set `z-index` style, etc., for the parent react-modal ([react-modal style format](https://github.com/reactjs/react-modal#styles))
106106
imagePadding | number | `10` | | Padding (px) between the edge of the window and the lightbox
107107
clickOutsideToClose | bool | `true` | | When true, clicks outside of the image close the lightbox
108108
enableZoom | bool | `true` | | Set to false to disable zoom functionality and hide zoom buttons
109109

110110
## Browser Compatibility
111111

112-
| Browser | Works? |
113-
|:-----|:-----|
114-
| Chrome | Yes |
115-
| Firefox | Yes |
116-
| Safari | Yes |
117-
| IE >= 10 | Yes |
118-
| IE 9 | Everything works, but no animations |
112+
| Browser | Works? |
113+
|:---------|:------------------------------------|
114+
| Chrome | Yes |
115+
| Firefox | Yes |
116+
| Safari | Yes |
117+
| IE >= 10 | Yes |
118+
| IE 9 | Everything works, but no animations |
119119

120120
## Contributing
121121

0 commit comments

Comments
 (0)