Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seeratawan01/vue-lazytube
Embed a YouTube and Vimeo player easily and lazy load the video to save resources and reduces initial load size.
https://github.com/seeratawan01/vue-lazytube
iframe iframe-embeds lazy-loading performance player video vimeo vimeo-api vue vue-lazytube vuejs youtube youtube-api
Last synced: 3 days ago
JSON representation
Embed a YouTube and Vimeo player easily and lazy load the video to save resources and reduces initial load size.
- Host: GitHub
- URL: https://github.com/seeratawan01/vue-lazytube
- Owner: seeratawan01
- License: mit
- Created: 2021-03-20T10:13:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-04T05:57:43.000Z (over 2 years ago)
- Last Synced: 2024-09-20T03:02:36.760Z (7 days ago)
- Topics: iframe, iframe-embeds, lazy-loading, performance, player, video, vimeo, vimeo-api, vue, vue-lazytube, vuejs, youtube, youtube-api
- Language: Vue
- Homepage: https://codesandbox.io/s/vue-lazytube-hj03y
- Size: 638 KB
- Stars: 37
- Watchers: 2
- Forks: 15
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Vue Lazytube
Embed a YouTube or Vimeo player easily and lazy load the video to save resources and reduces initial load size.
Useful when performance and page size is important or for sites with many embedded videos.
For a simple example page with 10 videos, vue-lazytube will reduce loadtime by 7x and memory usage by 2-3x.
[Demo online](https://codesandbox.io/s/vue-lazytube-forked-17o8v?file=/src/App.vue) | [Tutorial](https://medium.com/geekculture/light-and-responsive-youtube-embeds-faster-vue-web-page-load-speeds-c8e477b93f0f) | [Sponsor](https://patreon.com/seeratawan)
[](https://github.com/seeratawan01/vue-lazytube) [](https://opensource.org/licenses/MIT) [](https://www.npmjs.com/package/vue-lazytube) [](https://www.npmjs.com/package/vue-lazytube)
---
#### Table of Content
- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
* [Install Globally](#to-make-the-plugin-available-globally)
* [Install Locally](#to-include-only-in-specific-components)
- [Usage](#usage)
- [API](#api)
* [Props](#props)
* [Slots](#slots)
* [Methods](#methods)
* [Example](#example)
- [License](#open-source-license)
- [Buy Me a Coffee](#buy-me-a-coffee)
## Features
- reduces initial load size by ~1.1 MB per video
- fully responsive and customizable through `props`
- provides methods to control (`play`, `stop`, `pause` and `reset`) embedded videos
- provide options to set up custom title and preview of embedded videos
- platform supported: Youtube and Vimeo
## Demo
[](https://codesandbox.io/s/vue-lazytube-forked-17o8v?file=/src/App.vue)
## Installation
With a build systems
```sh
$ npm install --save vue-lazytube
```
```sh
$ yarn add vue-lazytube
```
### To make the plugin available globally
In your `main.js`:
```javascript
import LazyTube from "vue-lazytube";
Vue.use(LazyTube);
```
### To include only in specific components
```javascript
import { LazyYoutube, LazyVimeo } from "vue-lazytube";
export default {
name: 'YourComponent',
components: {
LazyYoutube,
LazyVimeo
},
}
```
## Usage
```javascript
```
## API
### Props
| Name | Type | Default Value | Description | Required |
| ------ | ------ | ------ | ------ | ------ |
| `src` | `String` | `` | To load video and iframe, should be Youtube/Vimeo video link. | `true` |
| `aspectRatio` | `String` | `16:9` | Maintaining the aspect ratio of video, perfect for responsively handling video embeds based on the width of the parent, should be in `*:*` format. e.g, `1:1`, `4:3`, `16:9` and `21:9`. | `false` |
| `maxWidth` | `String` | `560px` | Defines maximum width of video container. | `false` |
| `showTitle` | `Boolean` | `true` | Defines whether to show video title on top. | `false` |
| `autoplay` | `Boolean` | `false` | Defines whether to load the iframe as the page loads _(not recommended)_ | `false` |
| `thumbnailQuality` | `String` | `standard` | Defines the quality of thumbnail, should be one of the following `default`, `medium`, `high`, `standard` or `maxres` | `false` |
| `iframeClass` | `String` | `ly-iframe` | Defines the class on iframe element | `false` |
| `customTitle` | `String` | `` | Defines the custom title of the video | `false` |
| `customThumbnail` | `String` | `` | Defines the custom thumbnail image link of the video | `false` |
### Slots
This Component provides some slots. You can use the named slot to render custom play button and loader:
| Slot | Description |
| ------ | ------ |
| button | Slot gives an ability to provide custom play button |
| loader | Slot gives an ability to provide custom loader |
### Methods
These methods let you control the player using JavaScript, so you can perform the operations like `play`, `stop`, `pause` and `reset`.
>The user's browser must support the HTML5 postMessage feature. Most modern browsers support postMessage.
| Name | Type | Usage |
| ------ | ------ | ------ |
| playVideo | `function` | `this.$refs["lazyVideo"]['playVideo']()` |
| stopVideo | `function` | `this.$refs["lazyVideo"]['stopVideo']()` |
| pauseVideo | `function` | `this.$refs["lazyVideo"]['pauseVideo']()` |
| resetView | `function` | `this.$refs["lazyVideo"]['resetView']()` |
_Note: Must Replace `lazyVideo` with your [ref](https://v3.vuejs.org/guide/component-template-refs.html)._
### Example
```javascript
Play
Stop
Pause
Reset
export default {
name: "YourComponent",
components: {},
methods: {
handleClick(event) {
this.$refs["lazyVideo"][event]();
},
},
};
```
## Open Source License
You may use it under the terms of the [MIT Licenses](https://opensource.org/licenses/MIT)
## Buy Me a Coffee
[](https://patreon.com/seeratawan)