react-imagallery
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

react-imagallery

React Imagallery is react component for displaying image gallery.

imagallery

Table of Contents

Getting started

Installation

Imagallery can be installed using npm (with React 16.0.0 or later):

npm i react-imagallery

Example

You can see basic example of displaying images here.

Features

  • Fullscreen support
  • Thumbnail navigation
  • Swipe & drag gestures
  • Slideshow support
  • Responsive design
  • Customization

Props

  • items: (ImgGalleryItem[], required)
    • original: (string, required): image source URL
    • thumbnail: (string, required): image thumbnail source URL
    • originalAlt: (string): image alt
    • thumbnailAlt: (string): image thumbnail alt
  • selected: (number): selected item index to be displayed
  • autoPlay: (boolean): whether slideshow should play automatically
  • slideInterval: (number): interval between slides when slideshow is played
  • swipeDistance: (number): swipe distance needed for changing selected image
  • infinite: (boolean): whether images should create infinite loop
  • showControls: (boolean): whether to show controls
  • showThumbnails: (boolean): whether to show image thumbnails
  • showArrows: (boolean): whether to show arrows for changing selected image
  • onClose: (() => void): called when close button is clicked

Links

Package Sidebar

Install

npm i react-imagallery

Weekly Downloads

3

Version

1.0.2

License

GNU General Public License v3.0

Unpacked Size

112 kB

Total Files

8

Last publish

Collaborators

  • martan03