Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

Commit

Permalink
Change double quotes to single quotes
Browse files Browse the repository at this point in the history
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
  • Loading branch information
RayNjeri committed Nov 6, 2019
1 parent 6ae2126 commit b83da85
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions packages/components/psammead-media-player/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ This component to be used at any point on the page, specifically when a media pl

| Argument | Type | Required | Default | Example |
|-----------|---------------------|----------|---------|-----------------|
| `src` | string | Yes | - | `http://foobar.com/embeddable_endpoint` |
| `skin` | string | No | `"classic"` | `"audio"` |
| `title` | string | Yes | - | `Video player` |
| `service` | string | Yes | - | `"news"` |
| `src` | string | Yes | - | `'http://foobar.com/embeddable_endpoint'` |
| `skin` | string | No | `'classic'` | `'audio'` |
| `title` | string | Yes | - | `'Video player'` |
| `service` | string | Yes | - | `'news'` |
| `showPlaceholder` | boolean | No | `true` | `false` |
| `placeholderSrc` | string | No | `null` | `http://foobar.com/placeholder.png` |
| `placeholderSrcset` | string | No | `null` | `"https://bbc.com/300/cat.jpg 300w, https://bbc.com/450/cat.jpg 450w, https://bbc.com/600/cat.jpg 600w"` |
| `placeholderSrcset` | string | No | `null` | `'https://bbc.com/300/cat.jpg 300w, https://bbc.com/450/cat.jpg 450w, https://bbc.com/600/cat.jpg 600w'` |
| `portrait` | boolean | No | `false` | `true` |
| [`mediaInfo`](#mediaInfo) | object | Yes | - | `{ title: 'A vertical video pretending to be a cat title', duration: '2:30', durationSpoken: '2 minutes 11 seconds', datetime: 'PT2M30S' }`|

Expand All @@ -40,22 +40,22 @@ The `mediaInfo` prop is required, and has the following properties.

| Argument | Type | Required | Default | Example |
|-----------|---------------------|----------|---------|-----------------|
| `title` | string | Yes | - | `"A vertical video pretending to be a cat title"` |
| `datetime` | string | No| - | `"PT11S"` |
| `duration` | string| No | - | `"0:11"` |
| `durationSpoken` | string | No | - | `"11 seconds"` |
| `type` | string | No | `"video"` | `"audio"` |
| `guidanceMessage` | string | No | - | `"May contain strong language,sexual or violent content that may offend"` |
| `title` | string | Yes | - | `'A vertical video pretending to be a cat title'` |
| `datetime` | string | No| - | `'PT11S'` |
| `duration` | string| No | - | `'0:11'` |
| `durationSpoken` | string | No | - | `'11 seconds'` |
| `type` | string | No | `"video"` | `'audio'` |
| `guidanceMessage` | string | No | - | `'May contain strong language,sexual or violent content that may offend'` |

### AmpMediaPlayer

| Argument | Type | Required | Default | Example |
|-----------|---------------------|----------|---------|-----------------|
| `src` | string | Yes | - | `http://foobar.com/embeddable_endpoint` |
| `placeholderSrcset` | string | No | `null` | ` "https://bbc.com/300/cat.jpg 300w, https://bbc.com/450/cat.jpg 450w, https://bbc.com/600/cat.jpg 600w"` |
| `placeholderSrcset` | string | No | `null` | ` 'https://bbc.com/300/cat.jpg 300w, https://bbc.com/450/cat.jpg 450w, https://bbc.com/600/cat.jpg 600w'` |
| `title` | string | Yes | - | `Video player` |
| `portrait` | boolean | No | `false` | `true` |
| `placeholderSrc` | string | Yes | - | `http://foobar.com/placeholder.png` |
| `placeholderSrc` | string | Yes | - | `'http://foobar.com/placeholder.png'` |

The `placeholderSrc` prop is required for AMP, as in order to have the component load an `amp-iframe` within 600px or 75% of the viewport from the top, we must have an `amp-img` placeholder. For more information on this, please refer to the [AMP docs for amp-iframe](https://amp.dev/documentation/components/amp-iframe/).

Expand Down

0 comments on commit b83da85

Please sign in to comment.