Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for Vimeo vids in VideoEmbed #11412

Merged
merged 4 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
38 changes: 28 additions & 10 deletions common/views/components/VideoEmbed/VideoEmbed.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import PrismicHtmlBlock from '@weco/common/views/components/PrismicHtmlBlock/Pri

export type Props = {
embedUrl: string;
videoProvider?: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you constrain this type further?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

videoThumbnail?: string;
caption?: prismic.RichTextField;
transcript?: prismic.RichTextField;
hasFullSizePoster?: boolean;
Expand Down Expand Up @@ -54,16 +56,23 @@ const VideoTrigger = styled.button<{ $hasFullSizePoster?: boolean }>`

const VideoEmbed: FunctionComponent<Props> = ({
embedUrl,
videoProvider,
videoThumbnail,
caption,
transcript,
hasFullSizePoster,
}: Props) => {
const [isActive, setIsActive] = useState(false);
const id = embedUrl.match(/embed\/(.*)\?/)?.[1];
const hasAnalyticsConsent = getConsentState('analytics');
const isYouTube = embedUrl.indexOf('youtube') >= 0;
const isYouTube = videoProvider === 'YouTube';
const isVimeo = videoProvider === 'Vimeo';

useEffect(() => {
// TODO do we need analytics consent for vimeo?
// Do we need this?
/* <script src="https://player.vimeo.com/api/player.js"></script> */

if (isYouTube && hasAnalyticsConsent) {
// GA4 automatically tracks YouTube engagement, but requires the iframe api
// script to have been loaded on the page. Since we're lazyloading youtube
Expand All @@ -86,17 +95,31 @@ const VideoEmbed: FunctionComponent<Props> = ({
}
}, []);

const videoSrc = isYouTube
? `${embedUrl}&enablejsapi=1&autoplay=1`
: isVimeo
? `${embedUrl}&autoplay=1`
: undefined;

const thumbnailSrc = isYouTube
? `https://img.youtube.com/vi/${id}/${
hasFullSizePoster ? 'maxresdefault' : 'hqdefault'
}.jpg`
: isVimeo
? videoThumbnail
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you see this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did! But I wasn't sure we wanted to use some third party for this..? There's also this that could be worth a look https://github.com/vimeo/vimeo-oembed-examples ..

: undefined;

return (
<>
<VideoEmbedWrapper data-chromatic="ignore">
<IframeContainer>
{isActive ? (
{isActive && videoSrc ? (
<iframe
className="iframe"
title="Video"
allowFullScreen={true}
allow="autoplay; picture-in-picture"
src={`${embedUrl}&enablejsapi=1&autoplay=1`}
src={videoSrc}
style={{ border: 0 }}
/>
) : (
Expand All @@ -105,13 +128,8 @@ const VideoEmbed: FunctionComponent<Props> = ({
$hasFullSizePoster={hasFullSizePoster}
>
<span className="visually-hidden">Play video</span>
<YouTubePlay />
<img
src={`https://img.youtube.com/vi/${id}/${
hasFullSizePoster ? 'maxresdefault' : 'hqdefault'
}.jpg`}
alt=""
/>
{isYouTube && <YouTubePlay />}
{thumbnailSrc && <img src={thumbnailSrc} alt="" />}
</VideoTrigger>
)}
</IframeContainer>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ const VideoPlayerWrapper = styled.figure`
type VideoPlayerProps = {
title: string;
videoUrl: string;
videoProvider: 'YouTube' | 'Vimeo';
videoThumbnail?: string;
titleProps: { role: string; 'aria-level': number };
};

export const VideoPlayer: FunctionComponent<VideoPlayerProps> = ({
title,
videoUrl,
videoProvider,
videoThumbnail,
titleProps,
}) => (
<VideoPlayerWrapper>
Expand All @@ -44,7 +48,11 @@ export const VideoPlayer: FunctionComponent<VideoPlayerProps> = ({
{title}
</figcaption>
</Space>
<VideoEmbed embedUrl={videoUrl} />
<VideoEmbed
embedUrl={videoUrl}
videoProvider={videoProvider}
videoThumbnail={videoThumbnail}
/>
</VideoPlayerWrapper>
);

Expand Down Expand Up @@ -108,6 +116,8 @@ export const Stops: FunctionComponent<Props> = ({ stops, type }) => {
title={stopTitle}
titleProps={titleProps}
videoUrl={bsl.embedUrl}
videoProvider={bsl.provider}
videoThumbnail={bsl.thumbnail}
/>
)}
</Stop>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,11 @@ const ExhibitionGuidePage: FunctionComponent<Props> = props => {
{type === 'bsl' ? (
<>
{currentStop.video && (
<VideoEmbed embedUrl={currentStop.video} />
<VideoEmbed
embedUrl={currentStop.video}
videoThumbnail={currentStop.videoThumbnail}
videoProvider={currentStop.videoProvider}
/>
)}
</>
) : (
Expand Down
4 changes: 4 additions & 0 deletions content/webapp/services/prismic/transformers/body.ts
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,9 @@ export function transformEmbedSlice(
type: 'videoEmbed',
value: {
embedUrl: getVimeoEmbedUrl(embed),
videoProvider: 'Vimeo',
// TODO
// videoThumbnail
caption: slice.primary.caption,
transcript: slice.primary.transcript,
},
Expand All @@ -359,6 +362,7 @@ export function transformEmbedSlice(
type: 'videoEmbed',
value: {
embedUrl: getYouTubeEmbedUrl(embed),
videoProvider: 'YouTube',
caption: slice.primary.caption,
transcript: slice.primary.transcript,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
} from '@weco/content/types/exhibition-guides';

import { asRichText, asTitle } from '.';
import { getYouTubeEmbedUrl } from './embeds';
import { getVimeoEmbedUrl, getYouTubeEmbedUrl } from './embeds';
import { transformImagePromo } from './images';

export function transformExhibitionGuideToExhibitionGuideBasic(
Expand Down Expand Up @@ -99,8 +99,18 @@ export function transformExhibitionGuide(
: undefined,
bsl:
component['bsl-video'].provider_name === 'YouTube'
? { embedUrl: getYouTubeEmbedUrl(component['bsl-video']) }
: undefined,
? {
embedUrl: getYouTubeEmbedUrl(component['bsl-video']),
provider: 'YouTube' as const,
}
: component['bsl-video'].provider_name === 'Vimeo'
? {
embedUrl: getVimeoEmbedUrl(component['bsl-video']),
provider: 'Vimeo' as const,
thumbnail: component['bsl-video']
.thumbnail_url_with_play_button as string,
}
: undefined,
};
}
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ import {
isFilledLinkToMediaField,
PaginatedResults,
} from '@weco/common/services/prismic/types';
import { getYouTubeEmbedUrl } from '@weco/content/services/prismic/transformers/embeds';
import {
getVimeoEmbedUrl,
getYouTubeEmbedUrl,
} from '@weco/content/services/prismic/transformers/embeds';
import { transformRelatedExhibition } from '@weco/content/services/prismic/transformers/exhibition-guides';
import { transformQuery } from '@weco/content/services/prismic/transformers/paginated-results';
import { PromoSliceZone } from '@weco/content/services/prismic/types';
Expand Down Expand Up @@ -80,6 +83,15 @@ export function transformGuideStopSlice(
slice: RawGuideStopSlice
): GuideHighlightTour {
const title = asTitle(slice.primary.title);

const videoProvider = slice.primary?.bsl_video?.provider_name || undefined;

// We get the YouTube video through their API, so we don't need it here.
const videoThumbnail =
videoProvider === 'Vimeo'
? (slice.primary.bsl_video?.thumbnail_url_with_play_button as string)
: undefined;

return {
number: slice.primary.number || undefined,
title,
Expand All @@ -91,9 +103,13 @@ export function transformGuideStopSlice(
: undefined,
audioDuration: slice.primary.audio_duration || undefined,
video:
slice.primary.bsl_video.provider_name === 'YouTube'
videoProvider === 'YouTube'
? getYouTubeEmbedUrl(slice.primary.bsl_video)
: undefined,
: videoProvider === 'Vimeo'
? getVimeoEmbedUrl(slice.primary.bsl_video)
: undefined,
videoProvider,
videoThumbnail,
subtitles: slice.primary.subtitles
? asRichText(slice.primary.subtitles)
: undefined,
Expand Down
6 changes: 5 additions & 1 deletion content/webapp/types/exhibition-guides.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ export type GuideHighlightTour = {
transcript?: prismic.RichTextField;
audioDuration?: string;
video?: string;
subtitles?: prismic.RichTextField;
videoProvider?: string;
videoThumbnail?: string;
videoDuration?: string;
subtitles?: prismic.RichTextField;
image?: ImageType;
};

Expand All @@ -38,6 +40,8 @@ export type ExhibitionGuideComponent = {
audioWithoutDescription?: { url: string };
bsl?: {
embedUrl: string;
provider: 'YouTube' | 'Vimeo';
thumbnail?: string;
};
};

Expand Down