Skip to content

Commit

Permalink
docs: add notes about size prop
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewvasilchuk committed Mar 22, 2020
1 parent c9a45e1 commit 2f5d168
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,13 @@ export default {

## ⚙️ Properties

| Property | Required | Type | Default | Description |
| ----------- | -------- | ------ | --------------------------- | ------------------------------------------------------------------------------------------ |
| url | `true` | String | | Video `URL` in https://www.youtube.com/watch?v=VIDEO_ID format |
| alt | `false` | String | `"Video alternative image"` | Value of the `alt` attribute of the thumbnail `<img />` element |
| buttonLabel | `false` | String | `"Play video"` | Value of the `aria-label` attribute of the play `<button></button>` element. Improves a11y |
| aspectRatio | `false` | String | `"16:9"` | Aspect ratio. It helps to save proportions of the video on different container sizes |
| Property | Required | Type | Default | Description |
| ----------- | -------- | ------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| url | `true` | String | | Video `URL` in https://www.youtube.com/watch?v=VIDEO_ID format |
| alt | `false` | String | `"Video alternative image"` | Value of the `alt` attribute of the thumbnail `<img />` element |
| buttonLabel | `false` | String | `"Play video"` | Value of the `aria-label` attribute of the play `<button></button>` element. Improves a11y |
| aspectRatio | `false` | String | `"16:9"` | Aspect ratio. It helps to save proportions of the video on different container sizes |
| size | `false` | String | `"maxresdefault"` | Size of the thumbnail, generated by YouTube. Available variants: `default`, `mqdefault`, `sddefault`, `hqdefault`, `maxresdefault` |

## ⚙️ Events

Expand Down

0 comments on commit 2f5d168

Please sign in to comment.