React + BlueImp Gallery 🌄
gallery as a React component ;)
NOW! Your favoriteThis project is a tribute to a wonderful tool as BlueImp Gallery mixed with an awesome devel sandbox like Storybook. As a result we have a useful React component for a flexible slideshow gallery.
☝️How to start
install Reactive Blueimp Gallery in your project
npm install --save reactive-blueimp-gallery
✌️Usage
import the library into your component
;
Set a source with minimum requirements
const images = source: 'images/banana.jpg' source: 'images/apples.jpg' source: 'images/orange.jpg';
Use the component
<ReactGallery source=images />
and that's it! 🙌 a working version of BlueImp gallery into your React application 💪.
Options
As a HOC, this lib has some shortcut configurations for a full list of options that BlueImp Gallery offers.
ReactBlueImpGallery accepts the following props:
Property | Type | Description |
id | number | just an element identifier, attribute rendered into gallery HTML. |
className | string | class name to handle presentational aspects, attribute rendered into gallery HTML. |
withControls | boolean | to initialize the Gallery with visible controls.
|
inlineCarousel | boolean | to display the images in an inline carousel instead of a lightbox.
|
options | object | to send to BlueImp Gallery any of the supported options.
|
overlays | ReactBlueImpGallery.Overlays | to send custom overlays for slides. Lets talk about this in the next section. |
And finally, into options
prop you can find a useful custom event onopen
that return the original BlueImp Gallery instance allowing API control. See full API methods here
<ReactGallery options= gal source=images/>
Custom Overlays
Reactive BlueImp Gallery come with a helper component to customize slides overlay. Overlays
component allows you to include extra HTML elements over a slide and also has props to quick set up for existing elements. Overlays
is part of ReactBlueImpGallery
and can be accesed as an attribute of it.
const customOverlays = <ReactGalleryOverlays> <p className="footer-copywrite">® 2017 All rights reserved</p> </ReactGalleryOverlays>;<ReactGallery overlays=customOverlays source=images/>
In the example above we're adding a <p>
element into default slide overlay. Also you can define Overlays
props
Property | Type | Description |
className | string | to specify overlay CSS. |
noTitle | boolean | to hide default title element. |
noArrows | boolean | to hide default arrows (next/prev) elements. |
noClose | boolean | to hide default close (x) element. |
noPlayPause | boolean | to hide default play/pause element.
|
noIndicator | boolean | to hide default slide indicator (ooo) elements. |
Slides
The slide component it also comes as ReactBlueImpGallery
property. In the first example of this page, the slide component is receiving just one prop but they can accept others.
Property | Type | Description |
source | string | for image or video resource, this is an alias of `href` also valid for images but not for video slides. |
thumbanil | string | to set a resource to show in thumbanils. `source` will be used if `thumbnails` is undefined. |
type | string | to set slide mime type. `image/jpeg` by default. |
title | string | info to show in the slide overlay. |
✨ Slides with React content 🚀
BlueImp Gallery supports different slide types with a very good approach to customize content types. This way it supports HTML5, Youtube and Vimeo videos. Taking advantage of that smart design, this lib add a new content type to handle slide content with React components.
The content type is text/react
(no real mime type for React) and you can implement your React component like the following example.
const MyReactSlideContent = { return <p>My React slide content</p>;} ... <ReactGallery> <ReactGallerySlide thumbnail="images/thumbnails/banana.jpg" type="text/react" // to tell BlueImp Gallery which slide factory should use > <MyReactSlideContent /> </ReactGallerySlide></ReactGallery>
Of course you can have (or you'll need in real life scenarios) dynamic data into your React slide content, but if you need data from a parent component there's a little bit complex issue to solve. Since BlueImp Gallery is in charge of the slide render with vanilla javascript, React lost control of that HTML. In order to let React to render the slides, we're calling ReactDom method to draw custom component into the slide, but that way the scope of the component you wrote and the scope of the instance of your component into the slide are different. Then, a solution is an explicit definition of the data which should be sent to rendered instance of your componente. That can be achived setting a Slide
prop called SynchedData
like this
const MyReactSlideContent = { return <p>My React slide content with slideCount</p>;} ... <ReactGallery> <ReactGallerySlide thumbnail="images/thumbnails/banana.jpg" type="text/react" // to tell BlueImp Gallery which slide factory should use synchedData= slideCount: thisstateslideCount // this prop will be sent to <MyReactSlideContent /> > <MyReactSlideContent /> </ReactGallerySlide></ReactGallery>
Though this approach really works (you can see it here), you sould be very cautious about implementing React components architecture into slide contents.
Test and working examples
You can find many full working examples into ./stories folder.
clone this repo
git clone https://github.com/Cosmitar/reactive-blueimp-gallery.git
install dependecies
npm i
start storybook
npm run storybook
Have fun 🎉
Contributing
Pull requests and issues are welcome. If you've found a bug, please open an issue.
License
MIT