import React from 'react';
import { render } from 'react-dom';
import Gallery from 'react-grid-gallery';

const IMAGES =
[{
        src: "https://c2.staticflickr.com/9/8817/28973449265_07e3aa5d2e_b.jpg",
        thumbnail: "https://c2.staticflickr.com/9/8817/28973449265_07e3aa5d2e_n.jpg",
        thumbnailWidth: 320,
        thumbnailHeight: 174,
        caption: "After Rain (Jeshu John - designerspics.com)"
},
{
        src: "https://c2.staticflickr.com/9/8356/28897120681_3b2c0f43e0_b.jpg",
        thumbnail: "https://c2.staticflickr.com/9/8356/28897120681_3b2c0f43e0_n.jpg",
        thumbnailWidth: 320,
        thumbnailHeight: 212,
        caption: "Boats (Jeshu John - designerspics.com)"
},

{
        src: "https://c4.staticflickr.com/9/8887/28897124891_98c4fdd82b_b.jpg",
        thumbnail: "https://c4.staticflickr.com/9/8887/28897124891_98c4fdd82b_n.jpg",
        thumbnailWidth: 320,
        thumbnailHeight: 212
        //look ma, no caption!
}]

render(
        <Gallery images={IMAGES}/>,     
        document.getElementById('example-0')
);

Image Options

Property	Type	Default	Description
src	string	undefined	Required. A string referring to any valid image resource (file, url, etc).
thumbnail	string	undefined	Required. A string referring to any valid image resource (file, url, etc).
thumbnailWidth	number	undefined	Required. Width of the thumbnail image.
thumbnailHeight	number	undefined	Required. Height of the thumbnail image.
caption	string	undefined	Optional. Image caption.
srcset	array	undefined	Optional. Array of srcsets for lightbox.

Gallery Options

Property	Type	Default	Description
images	array	undefined	Required. An array of objects containing image properties (see Image Options above).
enableImageSelection	bool	true	Optional. Allow images to be selectable. Setting this option to `false` whilst supplying a non empty `selectedImages` array will result in those images being permanently selected.
selectedImages	array	empty	Optional. An array of image indicies to set as selected upon gallery creation (Note: this selection is permanent if `enableImageSelection: false`).
onSelectedImagesChange	func	undefined	Optional. Function to execute when selectedImages array changes (i.e. image selection has been updated). Optional arg: selectedImages array. This function is only executable when `enableImageSelection: true`.
rowHeight	number	180	Optional. The height of each row in the gallery.
margin	number	2	Optional. The margin around each image in the gallery.
enableLightbox	bool	true	Optional. Enable lightbox display of full size image when thumbnail clicked.
onClickThumbnail	func	openLightbox	Optional. Function to execute when gallery thumbnail clicked. Overrides openLightbox.

Property	Type	Default	Description
backdropClosesModal	bool	false	Optional. Allow users to exit the lightbox by clicking the backdrop.
currentImage	number	0	Optional. The index of the image to display initially (only relevant when used in conjunction with `isOpen: true` property).
preloadNextImage	bool	true	Optional. Based on the direction the user is navigating, preload the next available image.
customControls	array	undefined	Optional. An array of elements to display as custom controls on the top of lightbox.
enableKeyboardInput	bool	true	Optional. Supports keyboard input - `esc`, `arrow left`, and `arrow right`.
imageCountSeparator	string	' of '	Optional. Customize separator in the image count.
isOpen	bool	false	Optional. Whether or not the lightbox is displayed when gallery first rendered (can be used in conjunction with `currentImage` property, otherwise the first image will be diplayed).
showCloseButton	bool	true	Optional. Display a close "X" button in top right corner.
showImageCount	bool	true	Optional. Display image index, e.g., "3 of 20".

Using srcset:

images={[{
  src: 'http://example.com/example/img1.jpg',
  srcset: [
    'http://example.com/example/img1_1024.jpg 1024w',
    'http://example.com/example/img1_800.jpg 800w',
    'http://example.com/example/img1_500.jpg 500w',
    'http://example.com/example/img1_320.jpg 320w',
  ],
  thumbnail: 'http://example.com/example/thumbnailImg1.jpg',
  caption: "Image 1",
  thumbnailWidth: 180,
  thumbnailHeight: 320
},
{
  src: 'http://example.com/example/img2.jpg',
  srcset: [
    'http://example.com/example/img2_1024.jpg 1024w',
    'http://example.com/example/img2_800.jpg 800w',
    'http://example.com/example/img2_500.jpg 500w',
    'http://example.com/example/img2_320.jpg 320w',
  ],
  thumbnail: 'http://example.com/example/thumbnailImg2.jpg',
  caption: "Image 2",
  thumbnailWidth: 240,
  thumbnailHeight: 165
}

Read more about the srcset and sizes attributes here: https://ericportis.com/posts/2014/srcset-sizes/.

General Notes

As the inspiration for this component comes from Google Photos, very small thumbnails may not be the most aesthetically pleasing due to the border size applied when selected. A sensible rowHeight default of 180px has been chosen, but rowHeights down to 100px are still reasonable.
Gallery width is determined by the containing element.
Image Options: thumbnail can point to the same resource as src, bearing in mind the resultant data size of the gallery and page load cost. Thumbnails of whatever size will be scaled to match rowHeight.
If you don't know your thumbnailWidth and thumbnailHeight values, you can find these out using any number of javascript hacks, bearing in mind the load penalty associated with these methods.

License

React Grid Gallery is free to use for personal and commercial projects under the MIT License. Attribution is not required, but appreciated.

Acknowledgements

Visual design inspired by Google Photos.
Thumbnail viewport implementation inspired by GPlusGallery by Florian Maul.
Backend lightbox functionality via React Images by jossmac.
Demo stock photos:

v0.2.0 / 2016-09-03

Construction of thumbnail images and image rows removed from render. Thumbnails and rows now only rebuilt when container size changes.
selectedImages state now set via props change.
onSelectedImagesChange callback now called directly from onToggleSelected. Previously, a combination of setting selectedImages state and triggering onSelectedImagesChange inside componentWillUpdate caused a double render.
Internal image access now via state instead of props.
Thumbnail generation now atomic function rather than whole array at once.

Keywords

FAQs

What is react-grid-gallery?

Is react-grid-gallery popular?

Is react-grid-gallery well maintained?

Package last updated on 03 Sep 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install