https://github.com/display-design-studio/vue-player
Vue Video Player - Lightweight, customizable, and easy-to-implement vue video player.
https://github.com/display-design-studio/vue-player
dx lightweight open-source video video-player videos vue vue3
Last synced: 4 months ago
JSON representation
Vue Video Player - Lightweight, customizable, and easy-to-implement vue video player.
- Host: GitHub
- URL: https://github.com/display-design-studio/vue-player
- Owner: display-design-studio
- License: mit
- Created: 2024-01-19T10:01:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-06T12:13:23.000Z (10 months ago)
- Last Synced: 2025-02-06T08:01:55.671Z (4 months ago)
- Topics: dx, lightweight, open-source, video, video-player, videos, vue, vue3
- Language: Vue
- Homepage: https://display-design-studio.github.io/vue-player/
- Size: 9.73 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue Player
## Introduction
Lightweight, customizable, and easy-to-implement vue video player.
## Installation
```bash
$ npm i @display-studio/vue-player
```
## Setup
```js
import { VuePlayer } from '@display-studio/vue-player'
const sources = [
{
src: 'YOUR_URL',
type: 'video/mp4',
media: "(min-width: 900px)"
},
{
src: 'YOUR_URL_MOBILE',
type: 'video/mp4',
}
]
// Your custom controls here
.vue-player {
width: 100%;
position: relative;
height: fit-content;
line-height: 0;
video {
width: 100%;
height: auto;
}
}
```
## Nuxt Integration
The library is easy to implement in any Nuxt project.
Remember to wrap it on the `````` component.
```js
import { VuePlayer } from '@display-studio/vue-player'
// Your custom controls here
```
## Custom Controls
You can disable the native video tag controls and use your own custom ones.
#### Example:
`App.vue`
```js
import { VuePlayer } from '@display-studio/vue-player'
```
`MyControls.vue`
```js
import { useVuePlayer } from '@display-studio/vue-player'
const { playing, togglePlay, toggleMute, videoMuted } = useVuePlayer()
{{ playing ? "pause" : "play" }}
{{ videoMuted ? "unmute" : "mute" }}
.vue-player__controls {
position: absolute;
bottom: 0px;
right: 0px;
display: flex;
width: fit-content;
gap: 10px;
padding: 10px;
}
.vue-player__controls-toggleplay,
.vue-player__controls-togglemute {
flex: 0 0 auto;
display: block;
background-color: white;
border: none;
font-family: Arial, Helvetica, sans-serif;
font-size: 18px;
text-transform: uppercase;
border-radius: 5px;
padding: 2px 5px;
}
```
`MyPlayerDuration.vue`
```js
import { useVuePlayer } from '@display-studio/vue-player'
const { convertTimeToDuration, time, duration } = useVuePlayer()
.vue-player__timestamp {
flex: 2;
text-align: center;
position: absolute;
bottom: 0px;
left: 0px;
padding: 10px;
}
.vue-player__timestamp-inner {
background-color: white;
border-radius: 5px;
padding: 2px 5px;
font-family: Arial, Helvetica, sans-serif;
font-size: 18px;
user-select: none;
p {
display: inline-block;
line-height: 100%;
}
}
.vue-player__current-time {
color: royalblue;
}
.vue-player__separator {
color: royalblue;
}
.vue-player__duration {
font-weight: bold;
color: black;
}
```
`MyPlayerTrack.vue`
```js
import { useVuePlayer } from '@display-studio/vue-player'
const { percentagePlayed, seekToPercentage } = useVuePlayer()
seekToPercentage(e.target.value)" />
.vue-player__video-track {
padding: 0 0 10px;
position: absolute;
bottom: 0px;
left: 50%;
transform: translateX(-50%);
width: 50%;
height: 25px;
display: flex;
align-items: center;
}
.vue-player__video-track input[type="range"] {
position: relative;
overflow: hidden;
width: 100%;
-webkit-appearance: none;
background-color: white;
border-radius: 5px;
color: black;
}
.vue-player__video-track input[type="range"]:focus {
outline: none;
}
.vue-player__video-track input[type="range"]::-webkit-slider-runnable-track {
height: 6px;
-webkit-appearance: none;
color: black;
}
.vue-player__video-track input[type="range"]::-webkit-slider-thumb {
width: 6px;
-webkit-appearance: none;
height: 6px;
cursor: ew-resize;
background: black;
box-shadow: -245px 0 0 245px black;
}
```
## Provided props in the VuePlayer instance
| Name | Type | Description |
| ------------------------ | ---------- | -------------------------------------------------------------- |
| `togglePlay` | `Function` | Function to toggle play state |
| `playing` | `Boolean` | Play state |
| `toggleMute` | `Function` | Function to toggle mute state |
| `videoMuted` | `Boolean` | Mute state |
| `time` | `Number` | Current video time |
| `duration` | `Number` | Video duration |
| `convertTimeToDuration` | `Function` | Function to convert time |
| `percentagePlayed` | `Number` | Percentage played |
| `seekToPercentage` | `Function` | Function to set video current time based on clicked percentage |
| `openFullScreen` | `Function` | Enable fullscreen |
| `togglePictureInPicture` | `Function` | Enable PiP |
## Props
| Name | Type | Required | Default | Description |
| ------------------- | --------- | -------- | -------- | --------------------------------------------------------------------------------------------------- |
| `controls` | `Boolean` | `false` | `false` | Enable native video controls |
| `loop` | `Boolean` | `false` | `false` | Enable video loop |
| `width` | `Number` | `false` | | Video width |
| `height` | `Number` | `false` | | Video height |
| `autoplay` | `Boolean` | `false` | `false` | Enable autoplay |
| `muted` | `Boolean` | `false` | `false` | Mute video at the initialization |
| `poster` | `String` | `false` | | Source of the poster |
| `preload` | `String` | `false` | `"auto"` | Manage video loading [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#preload) |
| `sources` | `Array` | `false` | | Sources of the video |
| `togglePlayOnClick` | `Boolean` | `false` | | Enable toggle play on click |
#### Example:
```js
```
## Events
We have chosen the following events, but they may change.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#events) for more info.
| Event | Description |
|-----------------------|---------------------------|
|`play` | Triggered when the video starts |
|`pause` | Triggered when the video pause |
|`ended` | Triggered when the video end |
|`loadeddata` | The loadeddata event is fired when the frame at the current playback position of the media has finished loading; often the first frame. |
|`waiting` | The waiting event is fired when playback has stopped because of a temporary lack of data. |
|`playing` | The playing event is fired after playback is first started, and whenever it is restarted. For example, it is fired when playback resumes after having been paused or delayed due to a lack of data. |
|`timeupdate` | The timeupdate event is fired when the time indicated by the currentTime attribute has been updated.|
|`canplay` | The canplay event is fired when the user agent can play the media but estimates that not enough data has been loaded to play the media up to its end without having to stop for further buffering of content. |
|`canplaythrough` | The canplaythrough event is fired when the user agent can play the media and estimates that enough data has been loaded to play the media up to its end without having to stop for further buffering of content. |
|`statechanged` | Triggered when a state changed |
#### Example:
```js
import { VuePlayer } from '@display-studio/vue-player'
const myCustomFunction = ({ event }) => {
console.log(event)
}
```