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

Commit 4629f9e

Browse files
authored
Clarify purpose of thumbnail props
1 parent da13c43 commit 4629f9e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ Property | Type | Default | Required | Description
8787
mainSrc | string | | yes | Main display image url
8888
prevSrc | string | | | Previous display image url (displayed to the left). If left undefined, `onMovePrevRequest` will not be called, and the button not displayed
8989
nextSrc | string | | | Next display image url (displayed to the right). If left undefined, `onMoveNextRequest` will not be called, and the button not displayed
90-
mainSrcThumbnail | string | | | Thumbnail image url corresponding to `props.mainSrc`
91-
prevSrcThumbnail | string | | | Thumbnail image url corresponding to `props.prevSrc`
92-
nextSrcThumbnail | string | | | Thumbnail image url corresponding to `props.nextSrc`
90+
mainSrcThumbnail | string | | | Thumbnail image url corresponding to `props.mainSrc`. Displayed as a placeholder while the full-sized image loads.
91+
prevSrcThumbnail | string | | | Thumbnail image url corresponding to `props.prevSrc`. Displayed as a placeholder while the full-sized image loads.
92+
nextSrcThumbnail | string | | | Thumbnail image url corresponding to `props.nextSrc`. Displayed as a placeholder while the full-sized image loads.
9393
onCloseRequest | func | | yes | Close window event. Should change the parent state such that the lightbox is not rendered
9494
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.
9595
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.

0 commit comments

Comments
 (0)