Skip to content

Commit 336463c

Browse files
authored
Update Readme (#1116)
* Update Readme - Remove Froogaloop migration instructions (assuming no one still needs these) - Update supported browsers list - Clarify when embed options should be used - Update formatting for "notes" to match embed clarification formatting * add missing NOTE label
1 parent f5d3912 commit 336463c

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ You can use the library to make the embed for you. All you need is an empty
5757
element and the video id or vimeo.com url (and optional
5858
[embed options](#embed-options)).
5959

60-
**NOTE:** If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` property, you will need to provide the full video URL as a `url` property and include the `h` parameter.
60+
> [!NOTE]
61+
> If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` property, you will need to provide the full video URL as a `url` property and include the `h` parameter.
6162
6263
```html
6364
<div id="made-in-ny"></div>
@@ -80,6 +81,9 @@ element and the video id or vimeo.com url (and optional
8081
</script>
8182
```
8283

84+
> [!IMPORTANT]
85+
> Embed options will only be used when creating a new embed, not when attaching to an existing iframe.
86+
8387
### Automatically with HTML attributes
8488

8589
When the library loads, it will scan your page for elements with Vimeo
@@ -88,7 +92,8 @@ attributes. Each element must have at least a `data-vimeo-id` or
8892
You can also add attributes for any of the [embed options](#embed-options),
8993
prefixed with `data-vimeo` (`data-vimeo-portrait="false"`, for example).
9094

91-
**NOTE:** If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing a `data-vimeo-id` attribute, you will need to provide the full video URL in a `data-vimeo-url` attribute and include the `h` parameter.
95+
> [!NOTE]
96+
> If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing a `data-vimeo-id` attribute, you will need to provide the full video URL in a `data-vimeo-url` attribute and include the `h` parameter.
9297
9398
```html
9499
<div data-vimeo-id="19231868" data-vimeo-width="640" id="handstick"></div>
@@ -112,13 +117,8 @@ prefixed with `data-vimeo` (`data-vimeo-portrait="false"`, for example).
112117

113118
## Browser Support
114119

115-
The Player API library is supported in IE 11+, Chrome, Firefox, Safari, and
116-
Opera.
117-
118-
## Migrate from Froogaloop
119-
120-
Using our old Froogaloop library? See the [migration doc](docs/migrate-from-froogaloop.md)
121-
for details on how to update your code to use this library.
120+
The Player API library is supported in the last two versions of Edge, Firefox, Safari,
121+
Opera, and Chrome (incl. Chromium based browsers).
122122

123123
## Using with a module bundler
124124

@@ -295,7 +295,8 @@ Pass any element and an options object to the `Vimeo.Player` constructor to make
295295
an embed inside that element. The options object should consist of either an
296296
`id` or `url` and any other [embed options](#embed-options) for the embed.
297297

298-
**NOTE:** If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` property, you will need to provide the full video URL as a `url` property and include the `h` parameter.
298+
> [!NOTE]
299+
> If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` property, you will need to provide the full video URL as a `url` property and include the `h` parameter.
299300
300301
```html
301302
<div id="made-in-ny"></div>
@@ -431,7 +432,8 @@ player.off('play');
431432
Load a new video into this embed. The promise will be resolved if the video is
432433
successfully loaded, or it will be rejected if it could not be loaded.
433434

434-
**NOTE:** If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` argument, you will need to provide the full video URL as a `url` argument and include the `h` parameter.
435+
> [!NOTE]
436+
> If the video [privacy settings](https://help.vimeo.com/hc/en-us/articles/12426199699985-Overview-of-video-privacy-settings) are "Unlisted", instead of providing an `id` argument, you will need to provide the full video URL as a `url` argument and include the `h` parameter.
435437
436438
```js
437439
player.loadVideo(76979871).then(function(id) {

0 commit comments

Comments
 (0)