# react-fullscreen-slideshow

> A React full screen slideshow for images

Latest version **1.2.0** (published 2020-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-fullscreen-slideshow
pnpm add react-fullscreen-slideshow
yarn add react-fullscreen-slideshow
bun add react-fullscreen-slideshow
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-06-23 |
| First published | 2020-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 68 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Arut Selvan |
| Maintainers | arutselvan |
| Keywords | react, slideshow, fullscreen slideshow, react image slideshow, react image gallery |

## Links

- npm: https://www.npmjs.com/package/react-fullscreen-slideshow
- Repository: https://github.com/Arutselvan/react-fullscreen-slideshow
- Homepage: https://github.com/Arutselvan/react-fullscreen-slideshow#readme
- Issues: https://github.com/Arutselvan/react-fullscreen-slideshow/issues
- npm.io page: https://npm.io/package/react-fullscreen-slideshow

## Dependencies (1)

- [react-share](https://npm.io/package/react-share.md) ^4.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2020-06-23
- 1.1.8 — 2020-06-23
- 1.1.7 — 2020-06-17
- 1.1.6 — 2020-06-17
- 1.1.5 — 2020-06-16
- 1.1.4 — 2020-06-16
- 1.1.3 — 2020-05-28
- 1.1.2 — 2020-05-22
- 1.1.1 — 2020-05-22
- 1.1.0 — 2020-05-16
- 1.0.10 — 2020-05-16
- 1.0.9 — 2020-05-16
- 1.0.8 — 2020-05-16
- 1.0.7 — 2020-05-16
- 1.0.6 — 2020-05-16
- … 2 more at https://npm.io/package/react-fullscreen-slideshow/versions

## README

# react-fullscreen-slideshow

A simple React image fullscreen slideshow component

[View Demo](http://arutselvan.com/react-fullscreen-slideshow/)

### 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

```sh
npm install --save react-fullscreen-slideshow
```

### Usage

An example using react-fullscreen-slideshow

```javascript
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

---
_Source: https://npm.io/package/react-fullscreen-slideshow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._