react-media-box
v1.0.0
Published
A React lightbox that supports videos, images and pinch zooming on images. Optimized for mobile UI with swiping, but can be used on desktop as well.
Downloads
10
Maintainers
Readme
React image & video lightbox
Demo can be found here. It is best viewed on a mobile browser.
Installation:
npm install react-image-video-lightbox
Usage:
<ReactImageVideoLightbox
data={[
{ url: 'https://placekitten.com/450/300', type: 'photo', altTag: 'some image' },
{ url: 'https://www.youtube.com/embed/ScMzIvxBSi4', type: 'video', altTag: 'some video' },
{ url: 'https://placekitten.com/550/500', type: 'photo', altTag: 'some other image' },
{ url: 'https://www.youtube.com/embed/ScMzIvxBSi4', type: 'video', altTag: 'some other video' }
]}
startIndex={0}
showResourceCount={true}
onCloseCallback={this.callbackFunction} />
Properties:
|Property|Type|Description| |--------|----|-----------| |data|Array of resources|an array of resource objects (see resource object below)| |startIndex|number|index of image/video where the lightbox should open| |showResourceCount|boolean|show resource count in left upper corner| |onCloseCallback|Function => void|callback function called when the lightbox is closed|
Resource Object
|Property|Type|Description| |--------|----|-----------| |url|string|url of the image/video| |type|string|only two types are supported at this stage - images & videos (Youtube videos are recommended)| |altTag|string|alt tag for image/video|
More properties to follow...
Want to contribute?
Fork repo, submit pull request.
Have a feature request or improvement suggestion?
Create an issue on Github at: https://github.com/Ngineer101/react-image-video-lightbox/issues