Skip to content

Commit bb3a3f3

Browse files
committed
docs: add more migrating changes
1 parent e9c15ef commit bb3a3f3

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

MIGRATING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ These include:
2121
As of `v3.0` all the players are lazy loaded by default.
2222
Due to the use of `lazy` and `Suspense`, 🔥 __React 16.6 or later is now required__.
2323

24+
### Player props
25+
26+
As of `v3.0` some player props are renamed to be closer to the native
27+
[HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) naming.
28+
29+
- 🔥 __`url` => `src`__
30+
- 🔥 __`playsinline` => `playsInline`__
31+
- 🔥 __`progressInterval` deprecated
32+
- 🔥 __`stopOnUnmount` => deprecated
33+
- 🔥 __`wrapper` is `undefined` by default. Set to `div` if you want a wrapper element.
34+
2435
### Player instance methods
2536

2637
As of `v3.0` use [`ref`](https://react.dev/learn/manipulating-the-dom-with-refs) to call instance methods on the player. See [the demo app](examples/react/src/App.js) for an example of this. Since `v3`, the instance methods aim to be 🔥 __compatible

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ As of Chrome 66, [videos must be `muted` in order to play automatically](https:/
5555

5656
Prop | Description | Default
5757
---- | ----------- | -------
58-
`src` | The url of a video or song to play
58+
`src` | The url of a video or song to play | `undefined`
5959
`playing` | Set to `true` or `false` to pause or play the media | `false`
6060
`loop` | Set to `true` or `false` to loop the media | `false`
6161
`controls` | Set to `true` or `false` to display native player controls.<br/>&nbsp;&nbsp;For Vimeo videos, hiding controls must be enabled by the video owner. | `false`

0 commit comments

Comments
 (0)