video-react

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

VideoReact
video-react/video-reactvideo-react.js.org/video-react

README

video-react

npm version Build Status Package Quality codecov

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

Installation


Install video-react and peer dependencies via NPM

  1. ```sh
  2. npm install --save video-react react react-dom
  3. ```

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

  1. ``` js
  2. import '~video-react/dist/video-react.css'; // import css
  3. ```

or

  1. ```scss
  2. @import '~video-react/styles/scss/video-react'; // or import scss
  3. ```

or

  1. ``` html
  2. <link
  3.   rel="stylesheet"
  4.   href="https://video-react.github.io/assets/video-react.css"
  5. />
  6. ```

Import the components you need, example:

  1. ``` js
  2. import React from 'react';
  3. import { Player } from 'video-react';

  5. export default props => {
  6.   return (
  7.     <Player>
  8.       <source src="https://media.w3.org/2010/05/sintel/trailer_hd.mp4" />
  9.     </Player>
  10.   );
  11. };
  12. ```

Browser support


| Browser | Windows  |  Mac  | Linux | Android  |    iOS     |
| :-----: | :------: | :---: | :---: | :------: | :--------: |
| Chrome  |  Y   | Y | Y |  Y   | Native |
| Firefox |  Y   | Y | Y | untested | Native |
|  Edge   |  Y   |   -   |   -   |    -     |     -      |
|  IE 11  | untested |   -   |   -   |    -     |     -      |
| Safari  |    -     | Y |   -   |    -     |   Y    |

Please note that only the latest stable version is tested and supported. Video-react may be usable in older releases, and we will accept pull requests for them, but they will not be frequently tested or actively supported.

For the items marked as "untested", we do welcome volunteer testers.

Development


Run tests:

  1. ```sh
  2. npm test
  3. ```

Run from local


  1. ``` sh
  2. $ npm install
  3. $ npm start
  4. ```

Contribution


Interested in making contribution to this project? Want to report a bug? Please read the contribution guide.

Inspiration & Credits


- This project is heavily inspired by video.js, and most of our css styles came from video.js's styles.
- The document site is built with reactstrap.
- All the icons came from Google Material Icons
- Fonts were built by iconmon.