1.2.0 • Published 4 years ago
react-fullscreen-slideshow v1.2.0
react-fullscreen-slideshow
A simple React image fullscreen slideshow component
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
Prop | Type | Description | isRequired | Default |
---|---|---|---|---|
images | Array of objects | Array of objects containing image, caption and description. (See above example for reference) | Yes | NA |
title | string | Title of the image slideshow | Yes | NA |
cycle | boolean | Enable/disable infinite cycling of slides | No | false |
currentSlideIndex | number | Index of image from which the scrolling starts. | No | 0 |
BannerImgIndex | number | Index of the image to be used in the preview banner. | No | 0 |
displayOverlay | boolean | Show/hide the overlay text in the preview banner | No | true |
displayPreviewBanner | boolean | Show/hide the preview banner | No | true |
width | string | Sets the width of the preview. Examples: '100%', '50vw' | No | '100%' |
height | string | Sets the height of the preview. Examples: '300px', '40%' | No | 'auto' |
thumbnailsToBeDisplayed | number | Number of thumbnails that are visible at a time. | No | 8 |
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