1.2.0 • Published 4 years ago

react-fullscreen-slideshow v1.2.0

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

react-fullscreen-slideshow

A simple React image fullscreen slideshow component

View Demo

Features

  • Full screen modal slideshow with thumbnail navigation
  • Slideshow preview which can be clicked on for the fullscreen view.
  • Display captions and big descriptions along with the images
  • The View All view can be used for navigating galleries with large number of images

Installation

npm install --save react-fullscreen-slideshow

Usage

An example using react-fullscreen-slideshow

import React, { Component } from 'react';
import ReactFullscreenSlideshow from 'react-fullscreen-slideshow';

const images = [
    {
        image: 'images/image_1.jpg',
        caption: 'Caption for image_1',
        description: 'Description for image_1'
    },
    {
        image: 'images/image_2.jpg',
        caption: 'Caption for image_2',
        description: 'Very big description for image_2'
    },
    {
        image: 'images/image_3.jpg',
        caption: 'Image with no description'
    }
];

class App extends Component {
  render() {
    return (
        <div className="App"> 
            <ReactFullscreenSlideshow images={images} title={"Example Image slideshow"}/>
        </div>
    );
  }
}
export default App;

Props

PropTypeDescriptionisRequiredDefault
imagesArray of objectsArray of objects containing image, caption and description. (See above example for reference)YesNA
titlestringTitle of the image slideshowYesNA
cyclebooleanEnable/disable infinite cycling of slidesNofalse
currentSlideIndexnumberIndex of image from which the scrolling starts.No0
BannerImgIndexnumberIndex of the image to be used in the preview banner.No0
displayOverlaybooleanShow/hide the overlay text in the preview bannerNotrue
displayPreviewBannerbooleanShow/hide the preview bannerNotrue
widthstringSets the width of the preview. Examples: '100%', '50vw'No'100%'
heightstringSets the height of the preview. Examples: '300px', '40%'No'auto'
thumbnailsToBeDisplayednumberNumber of thumbnails that are visible at a time.No8

License

MIT

1.2.0

4 years ago

1.1.8

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago