Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
77 changes: 43 additions & 34 deletions src/runtime/components/ScriptVimeoPlayer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const props = withDefaults(defineProps<{
rootAttrs?: HTMLAttributes
aboveTheFold?: boolean
// copied from @types/vimeo__player
id: string | number | undefined
id: number | undefined
url?: string | undefined
autopause?: boolean | undefined
autoplay?: boolean | undefined
Expand All @@ -34,7 +34,7 @@ const props = withDefaults(defineProps<{
portrait?: boolean | undefined
responsive?: boolean | undefined
speed?: boolean | undefined
quality?: VimeoVideoQuality | undefined
quality?: Vimeo.VimeoVideoQuality | undefined
texttrack?: string | undefined
title?: boolean | undefined
transparent?: boolean | undefined
Expand All @@ -47,35 +47,40 @@ const props = withDefaults(defineProps<{
controls: true,
})

const emits = defineEmits<{
play: [e: EventMap['play'], player: Player]
playing: [e: EventMap['playing'], player: Player]
pause: [e: EventMap['pause'], player: Player]
ended: [e: EventMap['ended'], player: Player]
timeupdate: [e: EventMap['timeupdate'], player: Player]
progress: [e: EventMap['progress'], player: Player]
seeking: [e: EventMap['seeking'], player: Player]
seeked: [e: EventMap['seeked'], player: Player]
texttrackchange: [e: EventMap['texttrackchange'], player: Player]
chapterchange: [e: EventMap['chapterchange'], player: Player]
cuechange: [e: EventMap['cuechange'], player: Player]
cuepoint: [e: EventMap['cuepoint'], player: Player]
volumechange: [e: EventMap['volumechange'], player: Player]
playbackratechange: [e: EventMap['playbackratechange'], player: Player]
bufferstart: [e: EventMap['bufferstart'], player: Player]
bufferend: [e: EventMap['bufferend'], player: Player]
error: [e: EventMap['error'], player: Player]
loaded: [e: EventMap['loaded'], player: Player]
durationchange: [e: EventMap['durationchange'], player: Player]
fullscreenchange: [e: EventMap['fullscreenchange'], player: Player]
qualitychange: [e: EventMap['qualitychange'], player: Player]
camerachange: [e: EventMap['camerachange'], player: Player]
resize: [e: EventMap['resize'], player: Player]
enterpictureinpicture: [e: EventMap['enterpictureinpicture'], player: Player]
leavepictureinpicture: [e: EventMap['leavepictureinpicture'], player: Player]
}>()

const events = [
const emits = defineEmits<TEmits>()

type EventMap<E extends keyof Vimeo.EventMap> = [event: Vimeo.EventMap[E], player: Vimeo]

// eslint-disable-next-line ts/consistent-type-definitions
type TEmits = {
play: EventMap<'play'>
playing: EventMap<'playing'>
pause: EventMap<'pause'>
ended: EventMap<'ended'>
timeupdate: EventMap<'timeupdate'>
progress: EventMap<'progress'>
seeking: EventMap<'seeking'>
seeked: EventMap<'seeked'>
texttrackchange: EventMap<'texttrackchange'>
chapterchange: EventMap<'chapterchange'>
cuechange: EventMap<'cuechange'>
cuepoint: EventMap<'cuepoint'>
volumechange: EventMap<'volumechange'>
playbackratechange: EventMap<'playbackratechange'>
bufferstart: EventMap<'bufferstart'>
bufferend: EventMap<'bufferend'>
error: EventMap<'error'>
loaded: EventMap<'loaded'>
durationchange: EventMap<'durationchange'>
fullscreenchange: EventMap<'fullscreenchange'>
qualitychange: EventMap<'qualitychange'>
camerachange: EventMap<'camerachange'>
resize: EventMap<'resize'>
enterpictureinpicture: EventMap<'enterpictureinpicture'>
leavepictureinpicture: EventMap<'leavepictureinpicture'>
}

const events: (keyof TEmits)[] = [
'play',
'playing',
'pause',
Expand All @@ -99,6 +104,8 @@ const events = [
'qualitychange',
'camerachange',
'resize',
'enterpictureinpicture',
'leavepictureinpicture',
]

const elVimeo = ref()
Expand Down Expand Up @@ -133,15 +140,15 @@ if (import.meta.server) {
const { data: payload } = useAsyncData(
`vimeo-embed:${props.id}`,
// TODO ideally we cache this
() => $fetch(`https://vimeo.com/api/v2/video/${props.id}.json`).then(res => res[0]),
() => $fetch(`https://vimeo.com/api/v2/video/${props.id}.json`).then(res => (res as any)[0]),
{
watch: [() => props.id],
},
)

const placeholder = computed(() => payload.value?.thumbnail_large)

let player: Player | undefined
let player: Vimeo | undefined
// we can't directly expose the player as vue will break the proxy
defineExpose({
play: () => player?.play(),
Expand All @@ -158,6 +165,7 @@ defineExpose({
getPlaybackRate: () => player?.getPlaybackRate(),
setPlaybackRate: (rate: number) => player?.setPlaybackRate(rate),
})

onMounted(() => {
$script.then(async ({ Vimeo }) => {
// filter props for false values
Expand All @@ -170,7 +178,8 @@ onMounted(() => {
clickTriggered = false
}
for (const event of events) {
player!.on(event, (e) => {
player!.on(event, (e: EventMap<typeof event>) => {
// @ts-expect-error ts isn't able to infer the correct event type
emits(event, e, player)
Copy link
Member Author

Choose a reason for hiding this comment

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

not sure how we could correctly infer the type here

if (event === 'loaded')
ready.value = true
Expand Down
4 changes: 3 additions & 1 deletion src/runtime/registry/vimeo-player.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ import { useRegistryScript } from '../utils'
import type { RegistryScriptInput } from '#nuxt-scripts'
import { useHead } from '#imports'

type Constructor<T extends new (...args: any) => any> = T extends new (...args: infer A) => infer R ? new (...args: A) => R : never

export interface VimeoPlayerApi {
Vimeo: {
Player: VimeoPlayerApi
Player: Constructor<typeof window.Vimeo>
Copy link
Collaborator

Choose a reason for hiding this comment

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

🙌

}
}

Expand Down