@molecule/app-video-player-vue
v1.1.0
Published
HTML5 video player chrome — play/pause, scrub, elapsed/total time, mute toggle, fullscreen, optional caption track
Readme
@molecule/app-video-player-vue
Vue HTML5 video player chrome.
Exports <VideoPlayer> — a <video> element wrapped with custom
ClassMap-styled controls: play/pause, scrub bar, elapsed/total time,
mute toggle, fullscreen, optional caption track. It is the Vue counterpart
of @molecule/app-video-player-react: the same props (React names) and the
same DOM for the same input.
Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit
src/index.tsJSDoc, not this file.
Quick Start
import { createApp, defineComponent, h } from 'vue'
import { VideoPlayer } from '@molecule/app-video-player-vue'
const Player = defineComponent({
setup() {
return () =>
h(VideoPlayer, {
src: 'https://cdn.example.com/intro.mp4',
poster: 'https://cdn.example.com/intro-thumb.jpg',
captionsSrc: 'https://cdn.example.com/intro.vtt',
onEnded: () => console.log('watched to the end'),
})
},
})
createApp(Player).mount('#app')Type
feature
Installation
npm install @molecule/app-video-player-vue @molecule/app-ui @molecule/app-ui-vue @molecule/app-vue vueAPI
Interfaces
VideoPlayerProps
Props accepted by the {@link VideoPlayer} component.
interface VideoPlayerProps {
/** Video URL. */
src: string
/** Optional poster image URL. */
poster?: string
/** Caption track URL (.vtt). */
captionsSrc?: string
/** Caption language code. */
captionsLang?: string
/**
* Human-readable name of the captions track (the track's `label`, which
* screen readers and the browser's caption menu announce). Defaults
* through i18n (`video.captions`, English "Captions").
*/
captionsLabel?: string
/** Autoplay (must be muted to work in most browsers). */
autoPlay?: boolean
/** Initial muted state. */
defaultMuted?: boolean
/** Called when the media starts playing. */
onPlay?: () => void
/** Called when the media is paused. */
onPause?: () => void
/** Called when the media reaches its end. */
onEnded?: () => void
/** Extra classes. */
className?: string
}Constants
VideoPlayer
HTML5 video player with custom chrome — play/pause, scrub bar, elapsed/total time, mute, fullscreen. Native controls are hidden so the bar styles match the rest of the app (via ClassMap).
const VideoPlayer: DefineComponent<
ExtractPropTypes<{
src: { type: StringConstructor; required: true }
poster: StringConstructor
captionsSrc: StringConstructor
captionsLang: { type: StringConstructor; default: string }
captionsLabel: StringConstructor
autoPlay: { type: PropType<boolean | undefined>; default: undefined }
defaultMuted: { type: PropType<boolean | undefined>; default: undefined }
onPlay: PropType<VideoPlayerProps['onPlay']>
onPause: PropType<VideoPlayerProps['onPause']>
onEnded: PropType<VideoPlayerProps['onEnded']>
className: StringConstructor
}>,
() => VNode,
{},
{},
{},
ComponentOptionsMixin,
ComponentOptionsMixin,
{},
string,
PublicProps,
Readonly<
ExtractPropTypes<{
src: { type: StringConstructor; required: true }
poster: StringConstructor
captionsSrc: StringConstructor
captionsLang: { type: StringConstructor; default: string }
captionsLabel: StringConstructor
autoPlay: { type: PropType<boolean | undefined>; default: undefined }
defaultMuted: { type: PropType<boolean | undefined>; default: undefined }
onPlay: PropType<VideoPlayerProps['onPlay']>
onPause: PropType<VideoPlayerProps['onPause']>
onEnded: PropType<VideoPlayerProps['onEnded']>
className: StringConstructor
}>
> &
Readonly<{}>,
{ captionsLang: string; autoPlay: boolean | undefined; defaultMuted: boolean | undefined },
{},
{},
{},
string,
ComponentProvideOptions,
true,
{},
any
>props— Component props (see {@link VideoPlayerProps}).
Returns: The video player component.
Injection Notes
Requirements
Peer dependencies:
@molecule/app-ui^1.4.0@molecule/app-ui-vue^1.1.0@molecule/app-vue^3.5.0vue^3.4.0
Runtime Dependencies
@molecule/app-ui@molecule/app-ui-vue@molecule/app-vuevue
Renders its own <video> element directly — it does NOT use
@molecule/app-video's provider system; reach for that package when you
need an imperative, provider-swappable player. Volume control is a MUTE
TOGGLE only (no slider), and there is no PiP / playback-rate / quality
UI. Buttons use emoji glyphs (▶ ⏸ 🔇 🔊 ⛶). Only the Play/Pause labels
go through t('video.play') / t('video.pause'); the 'Seek',
'Mute'/'Unmute' and 'Fullscreen' aria-labels are hardcoded English (the
on-disk @molecule/app-locales-video-player bond carries only the two
play/pause keys and is not registered yet). autoPlay also forces the
initial state to muted (browser autoplay policy); captionsLang
defaults to 'en'. Single src URL only — no multi-source/quality list.
Props (documented on the exported VideoPlayerProps interface): src,
poster, captionsSrc, captionsLang, autoPlay, defaultMuted, onPlay,
onPause, onEnded, className.
Translations
Translation strings are provided by @molecule/app-locales-video-player.
