zjs-react-video
v1.0.6
Published
React component with the feature of save clips.
Downloads
2
Readme
zjs-react-video
React component with the feature of save clips.
Demo & Examples
Live demo: zerocooljs.github.io/react-zjs-video-component
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation
The easiest way to use zjs-react-video is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).
You can also use the standalone build by including dist/zjs-react-video.js
in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install zjs-react-video --save
Usage
You only have to import the component and use it.
import ZjsReactVideo from 'zjs-react-video';
<ZjsReactVideo
videoUrl="path/to/video.mp4"
title="Title of Video"
name="demo"
edit={true}
/>
Properties
- videoUrl: Path or URL of the video.
- title: Title for the interface.
- name: Unique name to keep persitent of clips.
- edit: Set if you want that the component only reproduce clips.
Notes
Please include these 2 tags at the HEAD
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Roboto:300,400,500,700" type="text/css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
Development (src
, lib
and the build process)
NOTE: The source code for the component is in src
. A transpiled CommonJS version (generated with Babel) is available in lib
for use with node.js, browserify and webpack. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
. If you just want to watch changes to src
and rebuild lib
, run npm run watch
(this is useful if you are working with npm link
).
License
MIT
Copyright (c) 2016 Jose Santacruz.