Responsive React Multimedia Gallery Component where you can deal with videos, photos and texts in the same way
npm install react-multimedia-gallery
A stateless responsive React multimedia gallery component to manage photos, texts and videos (only from youtube), that maintains the original aspect ratio of your photos and scales them responsively.
Add your own routing, lightbox, and manage your own state.
To install:
``
npm install --save react-multimedia-gallery
The images included in the video object are the thumbnail to show in the gallery before play de video.
http://acamposruiz.github.io/react-multimedia-gallery/
To build the examples locally, run:
`
npm install
npm start
Then open localhost:8000 in a browser.
`jsx
import React from 'react';
import Gallery from 'react-multimedia-gallery';
export default class Sample extends React.Component {
render() {
return (
);
}
}
const ARTICLE_SET = [
{
type:'article',
content:'Text1...',
},
{
type:'article',
content:'Text2...',
},
{
type:'article',
content:'Text3...',
},
]
const PHOTO_SET = [
{
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',
],
sizes:[
'(min-width: 480px) 50vw',
'(min-width: 1024px) 33.3vw',
'100vw'
],
width: 681,
height: 1024,
alt: 'image 1',
type: 'photo',
},
{
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',
],
sizes:[
'(min-width: 480px) 50vw',
'(min-width: 1024px) 33.3vw',
'100vw'
],
width: 600,
height: 600,
alt: 'image 2',
}
];
const VIDEO_SET = [
{
src: 'https://img.youtube.com/vi/
srcset: [
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
],
sizes:[
'(min-width: 480px) 50vw',
'(min-width: 1024px) 33.3vw',
'100vw'
],
width: 681,
height: 1024,
content: 'youtubeId1',
type: 'video',
},
{
src: 'https://img.youtube.com/vi/
srcset: [
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
'https://i1.ytimg.com/vi/
],
sizes:[
'(min-width: 480px) 50vw',
'(min-width: 1024px) 33.3vw',
'100vw'
],
width: 681,
height: 1024,
content: 'youtubeId2',
type: 'video',
}
];
const ITEMS_SET = PHOTO_SET.concat(VIDEO_SET.concat(ARTICLE_SET));
`
Property | Type | Default | Description
:-----------------------|:--------------|:--------------|:--------------------------------
items | array | undefined | required; array of objects that can be photos, videos on youtube or articles
cols | number | 3 | optional; number of photos per row
onClickItem | function | function | optional; do something when the user clicks a item
margin | number | 2 | optional; number of margin pixels around each entire image
Property | Type | Default | Description
:-----------------------|:--------------|:--------------|:--------------------------------
src | string | undefined | required; the img src attribute value of the gallery image
srcset | string | undefined | optional; the img srcset attribute value of the gallery image
sizes | string | undefined | optional; the img sizes attribute value of the gallery image
width | number | undefined | required; original width of the gallery image (only used for calculating aspect ratio)
height | number | undefined | required; original height of the gallery image (only used for calculating aspect ratio)
alt | string | undefined | optional; alt text of the gallery image
type | string | undefined | required set to photo value
Property | Type | Default | Description
:-----------------------|:--------------|:--------------|:--------------------------------
src | string | undefined | required; the img src attribute value of the gallery image
srcset | string | undefined | optional; the img srcset attribute value of the gallery image
sizes | string | undefined | optional; the img sizes attribute value of the gallery image
width | number | undefined | required; original width of the gallery image (only used for calculating aspect ratio)
height | number | undefined | required; original height of the gallery image (only used for calculating aspect ratio)
type | string | undefined | required set to video value
content | string | undefined | required; id of the video on youtube
Property | Type | Default | Description
:-----------------------|:--------------|:--------------|:--------------------------------
content | string | undefined | required; text content
type | string | undefined | required set to article value
The number of columns and when they change is something the user has control over in their app. The parameter cols allows the adjustment of the displayed colums. In combination with react-measure this allows the demo page to adjust colums (https://github.com/acamposruiz/react-multimedia-gallery/blob/master/examples/src/app.js#L103). Code snippet:
`
import { Measure } from 'react-measure';
function ResponsiveGallery (props) {
const { maxImageWidth = 300 } = props;
return (
{({ width }) => (
)}
);
}
This idea was discussed in #32 and proposed by @smeijer.
In the demo I chose to have one object of photos that I pass in to both the Gallery component and the Lightbox component to keep the code cleaner and stateless. Stateless because I can keep the Lightbox outside of the Gallery component and the user can decide whether to use any Lightbox of their choosing or none at all. I added all the properties into this object that either component might need or that I wanted to use for customization.
To gain a good understanding of 'srcset' and 'sizes' attributes, I found this site very helpful: https://ericportis.com/posts/2014/srcset-sizes/.