You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,8 @@ You can use the library to make the embed for you. All you need is an empty
57
57
element and the video id or vimeo.com url (and optional
58
58
[embed options](#embed-options)).
59
59
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.
61
62
62
63
```html
63
64
<divid="made-in-ny"></div>
@@ -80,6 +81,9 @@ element and the video id or vimeo.com url (and optional
80
81
</script>
81
82
```
82
83
84
+
> [!IMPORTANT]
85
+
> Embed options will only be used when creating a new embed, not when attaching to an existing iframe.
86
+
83
87
### Automatically with HTML attributes
84
88
85
89
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
88
92
You can also add attributes for any of the [embed options](#embed-options),
89
93
prefixed with `data-vimeo` (`data-vimeo-portrait="false"`, for example).
90
94
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.
@@ -112,13 +117,8 @@ prefixed with `data-vimeo` (`data-vimeo-portrait="false"`, for example).
112
117
113
118
## Browser Support
114
119
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).
122
122
123
123
## Using with a module bundler
124
124
@@ -295,7 +295,8 @@ Pass any element and an options object to the `Vimeo.Player` constructor to make
295
295
an embed inside that element. The options object should consist of either an
296
296
`id` or `url` and any other [embed options](#embed-options) for the embed.
297
297
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.
299
300
300
301
```html
301
302
<divid="made-in-ny"></div>
@@ -431,7 +432,8 @@ player.off('play');
431
432
Load a new video into this embed. The promise will be resolved if the video is
432
433
successfully loaded, or it will be rejected if it could not be loaded.
433
434
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.
0 commit comments