JSPM

  • Created
  • Published
  • Downloads 502888
  • Score
    100M100P100Q167842F
  • License MIT

react.js powered YouTube player component

Package Exports

  • react-youtube

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-youtube) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-youtube player component

Simple React component acting as a thin layer over the YouTube JS Player API

Features

  • url playback
  • playback event bindings
  • lazy API loading

Installation

$ npm install react-youtube

Usage

var React = require('react');
var YouTube = require('react-youtube');

var App = React.createClass({
  render: function() {
    return (
      <div>

        // `id` will be the YT Player iframe's container ID. Completely 
        // optional, defaults to 'react-yt-player'
        //
        // `autoplay` decides whether playback needs to be started manually
        //  or not, defaults to 'false'
        //
        // `url` is  the only parameter needed to play a video. Player automatically
        // loads it when it is changed.
        //
        // `playing`, `stopped`, and `ended` are event handlers called by the player.
        // They default to no-ops.

        <YouTube id={'react-player'}
                      autoplay={false}
                      url={'https://www.youtube.com/watch?v=OvJDiZwGGd4'}
                      onPlay={this._handlePlay}
                      onPause={this._handleStop}
                      onEnd={this._handleEnd}
        />

        // Simplest version of component
        <YouTube url={'https://www.youtube.com/watch?v=OvJDiZwGGd4'} />
      </div>
    );
  },

  _handlePlay: function() {
    console.log('video is playing');
  },

  _handleStop: function() {
    console.log('video is stopped');
  },

  // load a new video or call an alert or something like that.
  _handleEnd: function() {
      console.log('video has ended');
  }
});

Caveat

Programmatic control of the player as outlined in the API docs isn't included.

If decide to take control of it, be aware that the react-youtube uses loadVideoById, cueVideoById, addEventListener and removeEventListener internally.

Using these methods outside the component may cause problems.

License

MIT