Git Product home page Git Product logo

reactjs-videobg's Introduction

Build Status Coverage Status Commitizen friendly npm bundle size License: MIT code style: prettier

reactjs-videobg

Easily add background videos to your webapps

Installation

npm

npm i -S reactjs-videobg

yarn

yarn add reactjs-videobg

Development

This repo uses Commitizen for git commit conventions.

Run yarn commit or npm run commit

You'll be prompted to fill in any required fields and your commit messages will be formatted according to the standards

Usage

import React from "react";
import VideoBg from "reactjs-videobg";
import ogg from "./videos/Neon.ogg";
import webm from "./videos/Neon.webm";
import mp4 from "./videos/Neon.mp4";
import poster from "./img/poster.jpg";

<VideoBg poster={poster}>
  <VideoBg.Source src={ogg} type="video/ogg" />
  <VideoBg.Source src={webm} type="video/webm" />
  <VideoBg.Source src={mp4} type="video/mp4" />
</VideoBg>;

sandbox

FAQ

  1. How to show the poster if video has finished.

    This can be implemented with onEnded event handler. You could create an overlay and show it at the end of the video. Please have a look at this example

API

<VideoBg />

Prop Type Default Required Description
wrapperClass String none no className name for wrapper element.
videoClass String none no className name for video element.
loop Boolean true no Video will start over again.
autoPlay Boolean true no Video will start playing as soon as it is ready.
poster String none no The image to be shown while the videos are downloading.
muted Boolean true no Should audio of the video be muted?
onEnded Function none no Triggers on video end
onPlay Function none no Triggeres on play
onPlaying function none no Triggers on each time the video loops

<VideoBg.Source />

Prop Type Default Required Description
src String none yes static file or video file source
type String none yes video type

Resources

Videos: Pixabay - gr8effect - neon-terrain-80-retro-abstract Photos: Pixabay - MichaelGaida - nature-landscape-moor-high-fens

reactjs-videobg's People

Contributors

dependabot[bot] avatar samabeywickrama avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.