Installation

Package Manager

npm

npm install @vue-player/vue

pnpm

pnpm add @vue-player/vue

yarn

yarn add @vue-player/vue

Import Styles

The player styles must be imported once in your app entry point:

import '@vue-player/vue/styles'

In a Vue app (main.ts):

import { createApp } from 'vue'
import App from './App.vue'
import '@vue-player/vue/styles'

createApp(App).mount('#app')

HLS Streaming (Optional)

HLS support uses hls.js as an optional peer dependency. Install it if you need to play .m3u8 streams:

npm install hls.js

hls.js is loaded dynamically — it is not bundled into vue-player and is only imported at runtime when an HLS source is detected. Safari uses its native HLS support and does not require hls.js.

Nuxt

For Nuxt 3 projects, use the dedicated module instead:

npm install @vue-player/nuxt

See Nuxt Integration for setup details.