Skip to content

Commit 1d5fd85

Browse files
authored
[documentation] Adds thumbnail to list of props (#73)
After trying to add my own custom poster by overriding the styles myself, I noticed `thumbnail` was available already but missing from the props list.
1 parent 9daea43 commit 1d5fd85

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
@@ -258,6 +258,7 @@ The most minimalist implementation requires two props: `id` from the YouTube you
258258
| 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 possible |
259259
| 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](https://stackoverflow.com/questions/2068344/how-do-i-get-a-youtube-video-thumbnail-from-the-youtube-api) |
260260
| rel | string | Default `preload`. allows for prefetch or preload of the link url |
261+
| thumbnail | string | Pass an optional image url to override the default poster and set a custom poster image |
261262
| webp | boolean | Default `false`. When set, uses the WebP format for poster images |
262263
| wrapperClass | string | Pass the string class that wraps the iFrame |
263264

0 commit comments

Comments
 (0)