This repository has been archived by the owner on Aug 13, 2023. It is now read-only.
Update psammead-media-player prop documentation #2545
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
RayNjeri
requested review from
jamesbhobbs,
dr3,
j-pendlebury,
jroebu14 and
sareh
as code owners
added 5 commits
November 4, 2019 15:33
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
jamesdonoh
reviewed
Nov 4, 2019
|
|
||
| The `src` prop is required, as it tells the component what page it needs to embed. | ||
| The `placeholderSrcset` prop is not required, as it allows image responsiveness and optimization depending on the size of the screen. | ||
| The `title` prop is required for accessibility of the embedded iframe. | ||
| The `portrait` prop is not required, and defaults to `false`. This is to support portrait video content in the future. | ||
| The `mediaInfo` prop is required, as it shows info regarding the media such as title, duration, durationSpoken and type of media either Video or Audio |
There was a problem hiding this comment.
I think we should add another table documenting the constituent properties of the mediaInfo object and whether they are required etc. following the propType defined at https://github.com/bbc/psammead/blob/0be6fee4b760960535d08b9260c44d4ed1604942/packages/components/psammead-media-player/src/index.jsx#L88
added 2 commits
November 4, 2019 18:59
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
simonsinclair
suggested changes
Nov 4, 2019
There was a problem hiding this comment.
Thanks for updating this, @RayNjeri! Please can you add skin and service too?
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
…5-documentation Signed-off-by: RayNjeri <rachael.njeri@andela.com>
added 2 commits
November 5, 2019 10:47
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
RayNjeri
force-pushed
the
2475-documentation
branch
from
8cf9b50 to
38b7d48
Compare
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
RayNjeri
force-pushed
the
2475-documentation
branch
from
cf182c1 to
73a1790
Compare
Co-Authored-By: Simon Sinclair <simon.sinclair@bbc.co.uk>
Co-Authored-By: Simon Sinclair <simon.sinclair@bbc.co.uk>
Co-Authored-By: Simon Sinclair <simon.sinclair@bbc.co.uk>
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
RayNjeri
force-pushed
the
2475-documentation
branch
from
5a125bd to
b350a29
Compare
Signed-off-by: RayNjeri <rachael.njeri@andela.com>
RayNjeri
force-pushed
the
2475-documentation
branch
from
b350a29 to
b83da85
Compare
Co-Authored-By: Harvey Peachey <harvey.peachey@bbc.co.uk>
simonsinclair
approved these changes
Nov 6, 2019
j-pendlebury
approved these changes
Nov 6, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: RayNjeri rachael.njeri@andela.com
Resolves #2475
Overall change: Updates
@psammead-media-playerProps documentation .Code changes:
@psammead-media-playerREADME.md.