JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 30343
  • Score
    100M100P100Q135035F
  • License MIT

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

Package Exports

  • react-images

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-images) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Images

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

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.

Options

Property Type Description
backdropClosesModal bool Allow users to exit the lightbox by clicking the backdrop
enableKeyboardInput bool Supports keyboard input - esc, arrow left, and arrow right
initialImage number The index of the first image to display
height number Maximum height of the carousel; defaults to 600px
images array An array of image urls
isOpen bool Whether or not the lightbox is displayed
onClose func Handle closing of the lightbox
showCloseButton bool Optionally display a close button under the carousel
width number Maximum width of the carousel; defaults to 900px