Socket
Book a DemoInstallSign in
Socket

react-youtube-player

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-youtube-player

React component that encapsulates YouTube IFrame Player API and exposes player controls using the component properties.

latest
Source
npmnpm
Version
2.0.1
Version published
Maintainers
1
Created
Source

react-youtube-player

Travis build status NPM version js-canonical-style

React component that encapsulates YouTube IFrame Player API and exposes player controls using the component properties.

Implementation

componentDidMount callback is used to replace the rendered element with an iframe that loads a YouTube Player.

componentWillReceiveProps is used to detect when component properties change, compare them with the state of the YouTube Player and call YouTube IFrame Player API when necessary.

Usage

import YoutubePlayer from 'react-youtube-player';

/**
 * @typedef {string} YoutubePlayer~playbackState
 * @value 'unstarted' Stops and cancels loading of the current video. [stopVideo]{@link https://developers.google.com/youtube/iframe_api_reference#stopVideo}
 * @value 'playing' Plays the currently cued/loaded video. [playVideo]{@link https://developers.google.com/youtube/iframe_api_reference#playVideo}
 * @value 'paused' Pauses the currently playing video. [pauseVideo]{@link https://developers.google.com/youtube/iframe_api_reference#pauseVideo}
 */

/**
 * @property {string} videoId
 * @property {string|number} width (default: '100%').
 * @property {string|number} height (default: '100%').
 * @property {YoutubePlayer~playbackState} playbackState
 * @property {Object} configuration Configuration parameters to be passed to the YouTube Player (known as `playerVars` in the YouTube Player API for iframe Embeds, https://developers.google.com/youtube/player_parameters?playerVersion=HTML5#Parameters).
 */
<YoutubePlayer
    videoId=''
    playbackState='unstarted'
    configuration={
        {
            showinfo: 0,
            controls: 0
        }
    }
/>

Demo

To run the demo:

npm install
npm run build
npm run demo

Keywords

react-component

FAQs

Package last updated on 15 May 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts