Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blakewilson/vidbg
A minimal vanilla JavaScript video background plugin.
https://github.com/blakewilson/vidbg
es6 javascript video video-background
Last synced: 1 day ago
JSON representation
A minimal vanilla JavaScript video background plugin.
- Host: GitHub
- URL: https://github.com/blakewilson/vidbg
- Owner: blakewilson
- License: mit
- Created: 2015-10-26T07:39:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:33:31.000Z (almost 2 years ago)
- Last Synced: 2024-12-18T19:06:28.527Z (10 days ago)
- Topics: es6, javascript, video, video-background
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/vidbg.js
- Size: 7.86 MB
- Stars: 115
- Watchers: 6
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vidbg.js
A minimal vanilla JavaScript video background plugin.
## Compatibility
- All modern web browsers
- IE 11+
- All mobile web browsers that support autoplaying HTML5 ``
## Working With Wordpress
If you plan on using vidbg.js with WordPress, make your life a little bit easier and download the plugin I made on the [Wordpress Repo](https://wordpress.org/plugins/video-background/).
## Usage
### Install
```bash
npm install vidbg.js
```
Or [download the built `vidbg.zip` from GitHub](https://github.com/blakewilson/vidbg/releases/latest)
### Instructions
In the browser:
```html
```
Or if you are working with modules:
```js
import vidbg from "vidbg.js";
```
### Initializing the Script
The script accepts three arguments.
```js
var instance = new vidbg(selector, options, attributes);
```
The selector argument is any JavaScript selector, the [options](https://github.com/blakewilson/vidbg/tree/v2#options) are for configuring vidbg.js, and the [attributes](https://github.com/blakewilson/vidbg/tree/v2#attributes) argument modifies the actual `` element.
```js
var instance = new vidbg(
".vidbg-box",
{
mp4: "http://example.com/video.mp4", // URL or relative path to MP4 video
webm: "path/to/video.webm", // URL or relative path to webm video
poster: "path/to/fallback.jpg", // URL or relative path to fallback image
overlay: false, // Boolean to display the overlay or not
overlayColor: "#000", // The overlay color as a HEX
overlayAlpha: 0.3, // The overlay alpha. Think of this as the last integer in RGBA()
},
{
// Attributes
}
);
```
Note: Supplying both `.mp4` and `.webm` will increase browser compatibility.
### Options
```js
const defaultOptions = {
mp4: null,
webm: null,
poster: null,
overlay: false,
overlayColor: "#000",
overlayAlpha: 0.3,
};
```
### Attributes
```js
const defaultAttributes = {
autoplay: true,
controls: false,
loop: true,
muted: true,
playsInline: true,
};
```
### Overlay
Setting the `overlay` option to `true` will add an RGBA background over your video. This is helpful when you want to display text or meaningful content over the video background to increase legibility.
### Fallback Image Flashing
You may experience the fallback image flash on page load. This is because the fallback image is added through JavaScript. As a result of this, it will load after CSS styles are rendered.
If you'd like to combat this, you can preset the fallback image through CSS. For example, if your selector is `.video-box` you could do something like:
```css
.video-box .vidbg-container {
background-image: url(/assets/link-to-fallback.png);
}
```
### Methods
Below are the methods that are available:
```js
// First, create the vidbg.js instance.
var instance = new vidbg(".vidbg-box", {
mp4: "http://example.com/video.mp4",
webm: "path/to/video.webm",
poster: "path/to/fallback.jpg",
});
// Manually resize the video background
instance.resize();
// Manually play the video
instance.playVideo();
// Manually pause the video
instance.pauseVideo();
// Get the video playing state
instance.isVideoPlaying();
// Remove the element
instance.removeVideo();
// Completely remove the video background
instance.destroy();
```
## Media
Video and fallback image provided by Christophe Tauziet at https://vimeo.com/user27974867
## License
vidbg.js is licensed under The MIT License. You can view it [here](https://github.com/blakedotvegas/vidbg/blob/master/LICENSE).