cueplayer-react

Cueplayer.React is forked from video-react.

That project has been left unmaintained. The goals of this fork are to extend and rework this React based video player to support timeline markers and rewrite in typescript.

Installation

Install cueplayer-react and peer dependencies via NPM

npm install --save cueplayer-react react react-dom

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

import '~cueplayer-react/dist/cueplayer-react.css'; // import css

or

@import '~cueplayer-react/styles/scss/cueplayer-react'; // or import scss

or

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

Import the components you need, example:

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

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

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. Cueplayer-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:

npm test

Run from local

$ npm install
$ npm start

Contribution

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

Inspiration & Credits

• This project is a fork of video-react
• 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.