Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karim-mamdouh/ngx-lite-video
ngx-lite-video is an Angular package for lazy loading embedded YouTube and Vimeo videos, improving page speed and user experience.
https://github.com/karim-mamdouh/ngx-lite-video
angular iframe lazy-loading typescript vimeo vimeo-player youtube youtube-player
Last synced: about 2 months ago
JSON representation
ngx-lite-video is an Angular package for lazy loading embedded YouTube and Vimeo videos, improving page speed and user experience.
- Host: GitHub
- URL: https://github.com/karim-mamdouh/ngx-lite-video
- Owner: karim-mamdouh
- License: mit
- Created: 2023-04-16T13:59:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-10T19:57:02.000Z (about 1 year ago)
- Last Synced: 2024-11-15T23:20:31.906Z (about 2 months ago)
- Topics: angular, iframe, lazy-loading, typescript, vimeo, vimeo-player, youtube, youtube-player
- Language: TypeScript
- Homepage: https://karim-mamdouh.github.io/ngx-lite-video/
- Size: 499 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngx-lite-video
ngx-lite-video is an Angular package that provides lazy loading capabilities for embedded iframes from popular video sharing platforms like YouTube and Vimeo. The package is designed to optimize the loading of embedded videos, improving page load times and reducing data usage.
The package is built specifically for Angular, utilizing Angular's onpush change detection strategy for efficient rendering and updating of video components. It also includes features such as customizable lazy loading thresholds and options for controlling video playback and display.
This package requires a minimum of Angular version 13 and rxjs version 7.2 to function properly.
Try it yourself by measuring the performance on [Demo](https://karim-mamdouh.github.io/ngx-lite-video/) page
## Key Features
- Lazy loads embedded iframes for YouTube and Vimeo videos
- Built specifically for Angular
- Uses Angular OnPush change detection for optimized performance
- Customizable options including video quality, start time, and more
- Provides a seamless user experience by loading videos only when needed
## Install
```shell
npm install ngx-lite-video --save
```
Once installed, import the module that you wish to use in your desired module
```javascript
@NgModule({
//...
imports: [
//...
NgxLiteVimeoModule, // Vimeo lite module
NgxLiteYoutubeModule, // YouTube lite module
],
})
export class YourModule {}
```
## Usage
To use ngx-lite-video, add the 'ngx-lite-youtube'/'ngx-lite-vimeo' component to your template and configure its properties as needed:
```html
```
### Custom styles
To override styling create a class in global style.scss file & provide it to styleClass attribute
For more detailed examples see [Demo](https://karim-mamdouh.github.io/ngx-lite-video/) page
## API
### YouTube Attributes
| Property | Type | Default | Description |
| --------------- | ------- | --------- | -------------------------------------------- |
| videoId | string | undefined | Video ID to be viewed |
| videoTitle | string | undefined | Title to be displayed in lazy mode |
| hasControls | boolean | false | Shows/hides video controls in iframe |
| loop | boolean | false | Enables video looping |
| allowFullScreen | boolean | true | Enables/disables fullscreen button in iframe |
| start | number | undefined | Sets starting video time (in seconds) |
| end | number | undefined | Sets ending video time (in seconds) |
| styleClass | string | undefined | External styling class |
| thumbQuality | 'sd', 'medium', 'high', 'max' | 'high' | Lazy image quality |
### Vimeo Attributes
| Property | Type | Default | Description |
| ------------ | ------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| videoId | string | undefined | Video ID to be viewed |
| thumbQuality | 'sd', 'medium', 'high', 'max' | 'high' | Lazy image quality |
| showTitle | boolean | false | Enables/disables showing title in lazy mode |
| hasControls | boolean | false | Shows/hides video controls in iframe |
| loop | boolean | false | Enables video looping |
| isBackground | boolean | false | Enables vimeo background mode, please refer to [https://developer.vimeo.com/player/sdk/embed](https://developer.vimeo.com/player/sdk/embed) |
| styleClass | string | undefined | External styling class |
## Contributing
Contributions are welcome. You can start by creating new Issue with proposal or bug report.
## License
ngx-lite-video is an open source package released under the MIT license. See the LICENSE file for more information.