video-react

video-react

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

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

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

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

or

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

or

<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 (
    <Player>
      <source src="https://media.w3.org/2010/05/sintel/trailer_hd.mp4" />
    </Player>
  );
};

Development

Run tests:

npm test

run example to start developing your new component against

npm link # the link commands are important for local development npm install # disregard any warnings about missing peer dependencies npm start # runs rollup with watch flag

(in another tab)

cd example npm link video-react # link video-react with ../ npm install npm run dev # runs dev server http://localhost:9000/

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.
• react-modern-library-boilerplate
• nextjs

Changelog

0.9.0

• Using rollup to compile js
• Using nextjs to build doc site
• Fixed #60 - npm warnings with react v16
• Merged PR #64 - fix remove event listener

<a name="0.8.10"></a>