diff --git a/CHANGELOG.md b/CHANGELOG.md index 61a756e3..78e0b68e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. This projec Generated by [auto-changelog](https://github.com/CookPete/auto-changelog) +#### [v0.10.0](https://github.com/CookPete/react-player/compare/v0.9.0...v0.10.0) +> 25 September 2016 + +* Add `hidden` prop to ReactPlayer [`#102`](https://github.com/CookPete/react-player/pull/102) +* Use mounted property to prevent setting state when unmounted [`#105`](https://github.com/CookPete/react-player/issues/105) +* Update onProgress logic to still report loaded amounts when paused [`#94`](https://github.com/CookPete/react-player/issues/94) + + #### [v0.9.0](https://github.com/CookPete/react-player/compare/v0.8.0...v0.9.0) > 9 August 2016 diff --git a/README.md b/README.md index adcf672c..9e49e9b8 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,14 @@ ReactPlayer [![Latest npm version](https://img.shields.io/npm/v/react-player.svg)](https://www.npmjs.com/package/react-player) [![Build Status](https://img.shields.io/travis/CookPete/react-player/master.svg)](https://travis-ci.org/CookPete/react-player) [![Dependency Status](https://img.shields.io/david/CookPete/react-player.svg)](https://david-dm.org/CookPete/react-player) -[![devDependency Status](https://img.shields.io/david/dev/CookPete/react-player.svg)](https://david-dm.org/CookPete/react-player#info=devDependencies) +[![devDependency Status](https://img.shields.io/david/dev/CookPete/react-player.svg)](https://david-dm.org/CookPete/react-player?type=dev) -A react component for playing media from YouTube, SoundCloud and Vimeo, as well as supported media files. Used by [rplayr](http://rplayr.com), an app to generate playlists from Reddit URLs. +A react component for playing media from YouTube, SoundCloud, Streamable or Vimeo, as well as supported media files. Used by [rplayr](http://rplayr.com), an app to generate playlists from Reddit URLs. The component parses a URL and loads in the appropriate markup and external SDKs to play media from [various sources](#supported-media). [Props](#props) can be passed in to control playback and react to events such as buffering or media ending. +If you are using `npm` and need to support [browsers without `Promise`](http://caniuse.com/#feat=promises) you will need a [`Promise` polyfill](https://github.com/stefanpenner/es6-promise). If you are playing `Streamable` videos you will also need a [`fetch` polyfill](https://github.com/github/fetch) for [browsers without `fetch`](http://caniuse.com/#feat=fetch) + ### Usage ```bash @@ -78,6 +80,7 @@ Prop | Description | Default `volume` | Sets the volume of the appropriate player | `0.8` `width` | Sets the width of the player | `640` `height` | Sets the height of the player | `360` +`hidden` | Set to `true` to hide the player | `false` `className` | Pass in a `className` to set on the root element `style` | Add [inline styles](https://facebook.github.io/react/tips/inline-styles.html) to the root element `progressFrequency` | The time between `onProgress` callbacks, in milliseconds | `1000` @@ -120,8 +123,9 @@ To seek to a certain part of the media, there is a `seekTo(fraction)` instance m * YouTube videos use the [YouTube iFrame Player API](https://developers.google.com/youtube/iframe_api_reference) * Soundcloud tracks are [resolved](https://developers.soundcloud.com/docs/api/reference#resolve) and played in an [`