ImageGallery

Extends React.Component

React Component that represents an image gallery, consists of 1-4 images.

You can use count + path + sizes props or srcList + path props to create gallery

In order to use count + path + sizes template each image must have name in the format: {path}/{imageNumber}-{size}.jpeg.

Else you can hardcode each path using srcList prop.

Meta

• author: Oleg Nosov <olegnosov1@gmail.com>
• license: MIT

propTypes

Properties

• srcList Array<Array<string>> All gallery image paths. If you use this prop, don't specify count and sizes - they will be ignored. That array may contain 0-4 arrays of 3 strings. Each array of 3 strings - is an array of 3 image sizes paths, ['pathToSmallCat.jpeg', 'pathToMediumCat.jpeg', 'pathToBigCat.jpeg'] for example. Default is an empty array
• count number Image count. Max value is 4, min is 0. Default is 0
• path string Path to images. Default is an empty string
• sizes Array<string> Array of image sizes. Must contain 3 elements: 1st - small image (thumbnail), 2nd - medium image (main in gallery), 3rd - big image (lightbox preview). Default is ['102x68', '483x321', '800x533']

Demo

Live demo: https://www.solarleague.org/shop/macbook-case/

Usage

npm install --save react-image-gallery-lightbox

Example

import React from 'react';
import ImageGallery from 'react-image-gallery-lightbox';

import 'bootstrap/dist/css/bootstrap.css';
import 'react-image-gallery-lightbox/dist/image-gallery.css';
// If you have 3 instances(small, medium, big) of two images
// in folder /images/ like
//
// /images/1-85x50.jpeg,
// /images/1-680x400.jpeg,
// /images/1-1920x1080.jpeg
//
// /images/2-85x50.jpeg,
// /images/2-680x400.jpeg,
// /images/2-1920x1080.jpeg
<ImageGallery count={2} path="/images/" sizes={['85x50', '680x400', '1920x1080']}>
  <h3> Text content </h3>
</ImageGallery>
  // to show all of them
<ImageGallery count={1} path="/images/" sizes={['85x50', '680x400', '1920x1080']}>
  <h3> Text content </h3>
</ImageGallery>
  // to show only one image from list
// Of course you can specify each path as you wish
<ImageGallery
  srcList={[
    [
      '/images/1-85x50.jpeg',
      '/images/1-680x400.jpeg',
      '/images/1-1920x1080.jpeg'
    ],
    [
      '/images/2-85x50.jpeg',
      '/images/2-680x400.jpeg',
      '/images/2-1920x1080.jpeg'
    ]
  ]}
>
  <h3> Text content </h3>
</ImageGallery>

Development

Build

npm run build

And then check dist folder

Testing

Jest is used for tests

npm run test

Linter

ESLint is used as linter

npm run lint

Flow Type

Check types in project using Flow

npm run flow

Autodoc

Generate doc using documentation js

npm run doc

And then look at README.md