https://github.com/joelhooks/cueplayer-react
https://github.com/joelhooks/cueplayer-react
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joelhooks/cueplayer-react
- Owner: joelhooks
- License: mit
- Created: 2021-03-17T21:33:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-17T18:31:47.000Z (about 4 years ago)
- Last Synced: 2025-03-08T16:35:50.400Z (9 months ago)
- Language: JavaScript
- Homepage: cueplayer-react-git-main-skillrecordings.vercel.app
- Size: 9.28 MB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cueplayer-react
Cueplayer.React is forked from [video-react](https://github.com/video-react/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
```sh
npm install --save cueplayer-react react react-dom
```
import css in your app or add cueplayer-react styles in your page
```jsx
import '~cueplayer-react/dist/cueplayer-react.css'; // import css
```
or
```scss
@import '~cueplayer-react/styles/scss/cueplayer-react'; // or import scss
```
or
```html
```
Import the components you need, example:
```js
import React from 'react';
import { Player } from 'cueplayer-react';
export default props => {
return (
);
};
```
## 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:
```sh
npm test
```
### Run from local
```bash
$ npm install
$ npm start
```
## Contribution
Interested in making contribution to this project? Want to report a bug? Please read the [contribution guide](CONTRIBUTION.md).
## Inspiration & Credits
- This project is a fork of [video-react](https://github.com/video-react/video-react)
- This project is heavily inspired by [video.js](http://www.videojs.com), and most of our css styles came from [video.js's styles](https://github.com/videojs/video.js/tree/master/src/css).
- The document site is built with [reactstrap](https://github.com/reactstrap/reactstrap).
- All the icons came from [Google Material Icons](https://material.io/icons/)
- Fonts were built by [iconmon](https://icomoon.io/).