Skip to content

Commit 7443cff

Browse files
authored
🎨 docs: WebP prop added to documentation
1 parent 1f9df4a commit 7443cff

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,7 @@ Only two props are required to work: `id` from the YouTube you want to render an
254254
| playlist | boolean | Use `true` when your id be from a playlist |
255255
| playlistCoverId | string | The ids for playlists did not bring the cover in a pattern to render so you'll need pick up a video from the playlist (or in fact, whatever id) and use to render the cover. There's a programmatic way to get the cover from YouTube API v3 but the aim of this component is do not make any another call and reduce requests and bandwidth usage as much as possibe |
256256
| poster | string. One of `default` `mqdefault` `hqdefault` `sddefault` `maxresdefault` | Defines the image size to call on first render as poster image. See: https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api |
257+
| webp | boolean | Default `false`. When set, uses the WebP format for poster images |
257258
| wrapperClass | string | Pass the string class that wraps the iFrame |
258259
| onIframeAdded | function | Callback that will be called when iframe is added |
259260

0 commit comments

Comments
 (0)