0.6.0 • Published 4 years ago

image-tab-lightbox v0.6.0

Weekly downloads
22
License
MIT
Repository
github
Last release
4 years ago

React Images

react-images on npm Join the chat at https://gitter.im/react-images/Lobby

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

Quick start

npm install --save react-images

or

yarn add react-images
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:

yarn install
yarn start

Then open localhost:8000 in a browser.

Using srcSet

Example using srcSet:

<Lightbox
  images={LIGHTBOX_IMAGE_SET}
  ...
/>

const LIGHTBOX_IMAGE_SET = [
  {
    src: 'http://example.com/example/img1.jpg',
    caption: 'A forest'
    // As an array
    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',
    // As a string
    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',
  }
];

Options

PropertyTypeDefaultDescription
backdropClosesModalboolfalseAllow users to exit the lightbox by clicking the backdrop
closeButtonTitlestring' Close (Esc) 'Customize close esc title
enableKeyboardInputbooltrueSupports keyboard input - esc, arrow left, and arrow right
currentImagenumber0The index of the image to display initially
customControlsarrayundefinedAn array of elements to display as custom controls on the top of lightbox
imagesarrayundefinedRequired. Array of image objects See image options table below
imageCountSeparatorString' of 'Customize separator in the image count
isOpenboolfalseWhether or not the lightbox is displayed
leftArrowTitlestring' Previous (Left arrow key) 'Customize of left arrow title
onClickPrevfuncundefinedFired on request of the previous image
onClickNextfuncundefinedFired on request of the next image
onClosefuncundefinedRequired. Handle closing of the lightbox
onClickImagefuncundefinedHandle click on image
onClickThumbnailfuncundefinedHandle click on thumbnail
preloadNextImagebooltrueBased on the direction the user is navigating, preload the next available image
rightArrowTitlestring' Next (Right arrow key) 'Customize right arrow title
showCloseButtonbooltrueOptionally display a close "X" button in top right corner
showImageCountbooltrueOptionally display image index, e.g., "3 of 20"
widthnumber1024Maximum width of the carousel; defaults to 1024px
spinnerfuncDefaultSpinnerSpinner component class
spinnerColorstring'white'Color of spinner
spinnerSizenumber100Size of spinner
preventScrollbooltrueDetermines whether scrolling is prevented via react-scrolllock

Images object

PropertyTypeDefaultDescription
srcstringundefinedRequired
srcSetarray of strings or stringundefinedOptional
captionstringundefinedOptional
altstringundefinedOptional