knicklabs/react-images

A simple lightbox component for displaying an array of images

React Images

A simple, responsive lightbox component for displaying an array of images.

Quick start

import React from 'react';
import Lightbox from 'react-images';

export default class Sample extends React.Component {
  render() {
    return (
      <Lightbox
        images={[{ src: 'http://example.com/img1.jpg' }, { src: 'http://example.com/img2.jpg' }]}
        isOpen={this.state.lightboxIsOpen}
        onClickPrev={this.gotoPrevious}
        onClickNext={this.gotoNext}
        onClose={this.closeLightbox}
      />
    );
  }
}

Demo & Examples

Live demo: jossmac.github.io/react-images

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Example using srcset:

<Lightbox
  images={LIGHTBOX_IMAGE_SET}
  onClickPrev={this.gotoPrevious}
  onClickNext={this.gotoNext}
  onClose={this.closeLightbox}
/>

const LIGHTBOX_IMAGE_SET = [
  {
    src: 'http://example.com/example/img1.jpg',
    srcset: [
      'http://example.com/example/img1_1024.jpg 1024w',
      'http://example.com/example/img1_800.jpg 800w',
      'http://example.com/example/img1_500.jpg 500w',
      'http://example.com/example/img1_320.jpg 320w',
    ],
  },
  {
    src: 'http://example.com/example/img2.jpg',
    srcset: [
      'http://example.com/example/img2_1024.jpg 1024w',
      'http://example.com/example/img2_800.jpg 800w',
      'http://example.com/example/img2_500.jpg 500w',
      'http://example.com/example/img2_320.jpg 320w',
    ],
  }
];

Notes on srcset support:

The srcset attribute is supported by some modern browsers. Results of browser implementation and behaviour may vary. The sizes attribute uses the default maxWidth CSS property set to the image. By default this is 80% so 80vw.

Another thing to note is that 'h' or height in the srcset attribute does not yet exist. Because of the nature of the fixed height of a Lightbox this is problematic for portrait sized images. You will need to calculate what the best 'w' size for a portrait size ought to be given the height of the fixed viewport otherwise unnecessarily large images will be fetched. See issue: ResponsiveImagesCG/picture-element#86

Read more about the srcset and sizes attributes here: https://ericportis.com/posts/2014/srcset-sizes/.

Options

Property	Type	Default	Description
backdropClosesModal	bool	true	Allow users to exit the lightbox by clicking the backdrop
enableKeyboardInput	bool	true	Supports keyboard input - esc, arrow left, and arrow right
currentImage	number	0	The index of the image to display initially
height	number	600	Maximum height of the carousel; defaults to 600px
images	array	undefined	Required. An array of objects containing valid src and srcset values of img element
isOpen	bool	false	Whether or not the lightbox is displayed
onClickPrev	func	undefined	Required. Fired on request of the previous image
onClickNext	func	undefined	Required. Fired on request of the next image
onClose	func	undefined	Required. Handle closing of the lightbox
showCloseButton	bool	false	Optionally display a close button under the carousel
width	number	900	Maximum width of the carousel; defaults to 900px