ZzhAlan / video-react

A web video player built for the HTML5 world using React library.

Home Page:https://video-react.js.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


npm version Build Status Package Quality

Video.React is a web video player built from the ground up for an HTML5 world using React library.


Install video-react and peer dependencies via NPM

npm install --save video-react react react-dom

import css in your app or add video-react styles in your page

import "~video-react/dist/video-react.css"; // import css


@import "~video-react/styles/scss/video-react"; // or import scss


<link rel="stylesheet" href="https://video-react.github.io/assets/video-react.css" />

Import the components you need, example:

import React from 'react';
import { Player } from 'video-react';

export default (props) => {
  return (
      <source src="https://media.w3.org/2010/05/sintel/trailer_hd.mp4" />


Run tests:

npm test

run from local

$ npm install
$ npm start


Create Release Branch

To create a release branch and changelog, run the following command, optionally with a semantic release type (major, minor, patch) (if not provided, it will default to semver (it's best to let it default)):

./scripts/release <release-type>

Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.

Tagging and Publishing

Once the release branch is merged, checkout master and run:


Inspiration & Credits


A web video player built for the HTML5 world using React library.


License:MIT License


Language:JavaScript 70.7%Language:CSS 27.7%Language:Shell 1.7%