diff options
Diffstat (limited to 'changelog.md')
| -rw-r--r-- | changelog.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/changelog.md b/changelog.md index df2088dd..e76ee513 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,31 @@ # Changelog +# v1.9.0 +This version contains several ***breaking changes***: + +- `setup()` has been reverted to pre v1.8.0 behaviour; meaning it will return the *instance* rather than the *element*. This is because the reference to the instance is no longer added to the original element (see below). +- The reference to the `plyr` instance is now added to the media element rather than original container. This is because if a container with multiple children was passed to `setup()` the references to all instances would have been added to the container, creating issues. I would recommend using the return value from `setup()` or the new `get()` method to access the instance. +- Players will always be wrapped in their own div now - this makes `setup()` and `destroy()` cleaner. This *may* break any custom styling based on DOM position. + +And some other changes and bug fixes: + +- New `get()` method on the global plyr object to get all instances inside a container +- New API methods: + - `getOriginal()` to get the original, *unmodified* element plyr was setup on (`<video>`, `<audio>` or empty `<div>` for YouTube and Vimeo) + - `getContainer()` to get the players outer wrapper element + - `getMedia()` to get the players media element (`<video>`, `<audio>` or empty `<div>` for YouTube and Vimeo) + - `getEmbed()` to access the YouTube or Vimeo API directly + - `getType()` to get the type of the player + - `isReady()` to determine if an instance has completed setup and necessary APIs are loaded (for YouTube / Vimeo) + - `on()` to provide an easy way to listen to events + - `stop()` to, you guessed it, stop the player +- `destroy()` now works correctly for YouTube and Vimeo (fixes #272) +- New `destoryed` event when original element is restored (original element passed as event target) +- Default volume is now 10 (max) rather than 5 +- Sprite is only loaded once (fixes #259) +- Fixes for Vimeo post message bugs on source change or destroy (fixes #318) +- Save caption state in storage (fixes #311) + ## v1.8.12 - Vimeo keyboard focus fix (Fixes #317) - Fix for Vimeo on basic support devices |