Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@
"react-multi-carousel": "^2.5.5",
"react-player": "^2.6.2",
"react-select": "^3.1.0",
"react-slick": "0.26",
"react-typography": "^0.16.19",
"slick-carousel": "^1.8.1",
"styled-components": "^5.1.0",
"tailwindcss": "^1.4.6",
"twin.macro": "^1.1.0",
Expand Down
68 changes: 68 additions & 0 deletions src/components/tool/main-media-util-helper.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import { css } from "twin.macro"
export const SliderContentImageStyle = css`
height: inherit;
margin-left: auto;
margin-right: auto;
`
export const SliderStyle = css`
.slick-prev:before,
.slick-next:before {
color: #222425!important;
}
.slick-slide {
padding: 0rem 1rem 0rem 1rem;
}
`
export const SliderContentStyle = css`
margin: 1rem 0rem 1rem 0.1rem;
transition: transform .2s;
height: 8rem;
background: #f7f7f7;
text-align: center;
cursor: pointer;
border-radius: 0.5rem;

&:hover {
-ms-transform: scale(1.005);
-webkit-transform: scale(1.005);
transform: scale(1.005);
}

&:focus {
outline: none;
-webkit-box-shadow: 0px 0px 4px 0px rgba(173,173,173,1);
-moz-box-shadow: 0px 0px 4px 0px rgba(173,173,173,1);
box-shadow: 0px 0px 4px 0px rgba(173,173,173,1);
}
`
export const getSliderSetting = noOfElements => {
const maxSlidesToShow = noOfElements < 3 ? 2 : 3;
return {
focusOnSelect: true,
dots: true,
infinite: false,
speed: 500,
slidesToShow: maxSlidesToShow,
slidesToScroll: 1,
responsive: [{
breakpoint: 1200,
settings: {
slidesToShow: maxSlidesToShow,
slidesToScroll: 1
}
}, {
breakpoint: 600,
settings: {
slidesToShow: 2,
slidesToScroll: 1
}
}, {
breakpoint: 480,
settings: {
slidesToShow: 1,
slidesToScroll: 1
}
}
]
}
}
167 changes: 167 additions & 0 deletions src/components/tool/main-media-util.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
import React, { useState, useEffect } from "react"
import tw, { css } from "twin.macro"
import ReactPlayer from "react-player/lazy"
import "slick-carousel/slick/slick.css"
import "slick-carousel/slick/slick-theme.css"
import Slider from "react-slick"
import {
SliderContentImageStyle,
SliderStyle,
SliderContentStyle,
getSliderSetting
} from "./main-media-util-helper"

/**
*
* **Credits**
* Author : yangshun
* Gist link : https://gist.github.com/yangshun/9892961
*/
const parseVideo = url => {
url.match(/(http:|https:|)\/\/(player.|www.)?(vimeo\.com|youtu(be\.com|\.be|be\.googleapis\.com))\/(video\/|embed\/|watch\?v=|v\/)?([A-Za-z0-9._%-]*)(&\S+)?/);

const type = RegExp.$3.indexOf("youtu") > -1 ? "youtube" :
RegExp.$3.indexOf("vimeo") > -1 ? "vimeo"
: undefined

return {
type: type,
id: RegExp.$6
}
}

const getVideoThumbnailUrl = async url => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eventually I'd love to move the thumbnail creation to build time.
This could be done similarly to the screenshot creation in gatsby-node.js.
The advantage would be that we don't have to run the thumbnail generation on the client.
I think this is a bit outside of the scope of this PR, so let me know if you want to get this in or if we should tackle that at a later point in time.

Copy link
Author

@kots14 kots14 Oct 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mre I'd like to understand whether you want the thumbnails to be downloaded as images or are you referring creation of the thumbnail links at the time of build? Please let me know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we should download the thumbnails as images yes.
Guess you could copy-and-paste this section in the config and replace screenshot with thumbnail.
https://github.com/analysis-tools-dev/website/blob/4d8a0b46e41158fbac61327ced1f6ee49059c21e/gatsby-node.js#L148-L155
Then wherever you need the thumbnail you can use it as a field similar to the screenshot field:
https://github.com/analysis-tools-dev/website/blob/8b82484b73a342618947cf0c48f1340dd11407b3/src/components/tool/main-media.js#L36

Not sure if that's understandable. If not I can add a commit and we can have a look.

Copy link
Author

@kots14 kots14 Nov 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mre Can you please help me out with a npm package that can download thumbnails? I'm trying to work on this actually and so far I was unable to find any. Also, please let me know if I can utilise the code from screenshot.js for downloading thumbnails - I'm trying this as you suggested previously.

Copy link
Member

@mre mre Nov 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please help me out with a npm package that can download thumbnails?

Oh you can totally use your thumbnail code. You could have a thumbnail.js with your code next to screenshot.js and then call that code from gatsby.node.js like above; so something like:

// This could return a dictionary of `{ "<resouce_url>": "<thumbnail_path>" }` or so.
// Alternatively we return `node.resources` with one more field `thumbnail` per entry. 
 const thumbnails = await getThumbnails(node.resources) 
 if (thumbnails) { 
   createNodeField({ 
     node, 
     name: `thumbnails`, 
     value: thumbnails, 
   }) 
 } 

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like I'm in the right path already, I'll get back to you if I'm stuck. Thanks :)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mre I've updated the code in this PR. I apologise for the delay.
I tried to put the thumbnail related data under node.resources. However, I couldn't figure it out. Hence, I went with the approach for which you already gave an example. I'm using image-downloader package to download the thumbnails at the build time. I hope that this would sort out all the issues.
Please let me know if further changes are required.

const video = parseVideo(url)
if (video.type === "youtube")
return video.id ? "https://img.youtube.com/vi/" + video.id + "/maxresdefault.jpg" : "#"
if (video.type === "vimeo") {
const fetched = (async videoId => {
let result = {}
try {
const response = await fetch("https://vimeo.com/api/v2/video/" + videoId + ".json")
result = await response.json()
return result[0].thumbnail_large
} catch (e) {
console.error("Error while fetching Vimeo video data", e)
}
})
return fetched(video.id)
}
}

const renderMainMediaDisplayElement = {
video: video => {
return (
<div tw="h-full text-center" key={video.key} id={video.key} css={video.css}>
<ReactPlayer url={video.url} width="100%" controls={true}/>
</div>
)
},
image: image => (
<a href={image.url} tw="w-full text-center" css={image.css}
key={image.key} id={image.key}>
<img
alt={`Screenshot of ${image.name} website`}
tw="border-4 max-w-full inline-block"
src={image.src}
/>
</a>
),
}

const renderMainMediaSliderElement = {
video: video => sliderThumbnail(video),
image: image => sliderThumbnail(image)
}

const sliderThumbnail = props => {
props = props || {}
const src = props.src || props.thumbnailSrc || "#"
const alt = props.name || "Thumbnail"
return (
<div css={[SliderContentStyle]}
id={props.key}
key={props.key}
onClick={props.onClick}
aria-hidden="true">
<img
alt={alt}
id={props.key + "_img"}
key={props.key + "_img"}
src={src}
css={[
tw`border-4 max-w-full`,
SliderContentImageStyle
]}
/>
</div>
)
}

export const MainMediaUtil = ({data}) => {
const [items] = useState(data)
const [index, setIndex] = useState(0)
const [isRendered, setIsRendered] = useState(false)
const [hasThumbnails, setHasThumbnails] = useState(false)
const sliderSetting = getSliderSetting(items.length)

const toggleDisplayStatusOfElement = options => {
options = options || {}
const idForElementToDisplay = "#main_media_util_in_display_" + index
const elementToDisplay = document.querySelector(idForElementToDisplay)
elementToDisplay.setAttribute('style', options.style || 'display:block')

if (isRendered) return
const idForElementToFocus = "#main_media_util_" + index
const elementToFocus = document.querySelector(idForElementToFocus)
elementToFocus.focus({ preventScroll: true })
setIsRendered(true)
}

const populateVideoThumbnails = async () => {
items.map(async item => {
if (item.type !== "video") return
const url = await getVideoThumbnailUrl(item.source.url)
const target = document.querySelector("#" + item.source.key + "_img")
target.setAttribute("src", url)
})
setHasThumbnails(true)
}

useEffect(() => {
if (items.length > 1) toggleDisplayStatusOfElement()
if (!hasThumbnails) populateVideoThumbnails()
})

return items && items.length > 1 ? (
<>
<div tw="items-center h-full mb-1">
{items.map((item, itemIndex) => {
item.source.key = "main_media_util_in_display_" + itemIndex
item.source.css = css`display:none;`
return renderMainMediaDisplayElement[item.type](item.source)
})}
</div>
<div tw="items-center h-full ml-2 mr-2">
<Slider {...sliderSetting} css={[SliderStyle]}>
{items.map((item, itemIndex) => {
item.source.key = "main_media_util_" + itemIndex
item.source.onClick = () => {
if (itemIndex === index) return
toggleDisplayStatusOfElement({style : 'display:none' })
setIndex(itemIndex)
}
return renderMainMediaSliderElement[item.type](item.source)
})}
</Slider>
</div>
</>
) : (
<div tw="flex justify-center items-center h-full mb-5 pb-4">
{items && items.map(item => {
item.source.key = "main_media_util_in_display_0"
return renderMainMediaDisplayElement[item.type](item.source)
})}
</div>
)
}
44 changes: 2 additions & 42 deletions src/components/tool/main-media.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from "react"
import "twin.macro"
import ReactPlayer from "react-player/lazy"
import Carousel from "react-multi-carousel"
import { MainMediaUtil } from "./main-media-util"

const getVideo = resources => {
if (!resources) {
Expand All @@ -15,22 +14,6 @@ const getVideo = resources => {
}
}

const renders = {
video: video => (
<ReactPlayer tw="max-w-full" url={video.url} width="100%" controls="true" />
),
image: image => (
<a href={image.url} tw="w-full text-center">
<img
alt={`Screenshot of ${image.name} website`}
tw="border-4 max-w-full inline-block"
src={image.src}
height="360"
/>
</a>
),
}

const MainMedia = ({ tool }) => {
const { name, homepage, resources } = tool
let screenshot = { name, url: homepage, src: tool.fields.screenshot }
Expand All @@ -45,32 +28,9 @@ const MainMedia = ({ tool }) => {
items.push({ type: "video", source: video })
}

const carouselProps = {
responsive: {
all: {
breakpoint: { max: 3000, min: 0 },
items: 1,
},
},
infinite: true,
showDots: true,
}

return (
<div tw="mb-5">
{items.length > 1 ? (
<Carousel {...carouselProps}>
{items.map(item => (
<div tw="flex justify-center items-center h-full mb-5 pb-4">
{renders[item.type](item.source)}
</div>
))}
</Carousel>
) : (
<div tw="flex justify-center items-center h-full mb-5 pb-4">
{renders[items[0].type](items[0].source)}
</div>
)}
<MainMediaUtil data={items} />
</div>
)
}
Expand Down
Binary file modified static/screenshots/github/githubcommetricsgrimoirecmetrics.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading