vue-video-background

A full width video background component for VueJS
2,049 6
vue
Install
npm install vue-video-background
Latest Version:0.1.2
License:MIT
Last Updated:Jul 28, 2017
Links: GitHub  ·  npm
Maintainer: sewede

vue-video-background

npm version

A Vue component for a full width video background.

This package is in active development. Feel free to contribute. If you have any problems please open an issue on Github.

Usage

  1. Install via npm

npm install --save vue-video-background

  1. Import the component

import VueVideoBackground from 'vue-video-background'

  1. Use the component

You must at least give the videoSrc-prop.

<vue-video-background videoSrcWebm="path/to/your/video/file.webm"></vue-video-background>

Source file can be .webm or mp4 or specify both types for greater browser support. Webm will always be used first.

Settings

Option Type Default Description
videoSrcWebm string '' The path to your .webm video source.
videoSrcMp4 string '' The path to your .mp4 video source.
poster string '' Path to preview image. Will be replaced by video once it loads.
textOverlay boolean false Whether to show a text overlay or not.
textHeadline string '' The Headline for your text overlay. Will be in h1-tags.
textSubtitle string '' The Subtitle for your text overlay. Will be in h2-tags.
textBody string '' The text for your text overlay. Will be in p-tags.

Related Packages

vue

The progressive JavaScript framework for building modern web UI.

588,019,132 54,801
vue
@vueuse/shared
372,738,348 22,398
@vueuse/core

Collection of essential Vue Composition Utilities

367,188,523 22,398
@vitejs/plugin-vue

The official plugin for Vue SFC support in Vite.

333,357,380 686
eslint-plugin-vue

Official ESLint plugin for Vue.js

266,364,830 4,591

Version History

Version Released License
0.1.2 MIT
0.1.1 MIT
0.1.0 MIT
0.0.1 MIT