Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(video-embed): update play button usage information #2125

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
4 changes: 3 additions & 1 deletion elements/rh-video-embed/docs/10-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ The video embed element consists of a semitransparent play button with a video t

## Theme

The video embed element is available in both light and dark themes. It can include either a light or a dark play button, depending on the thumbnail image underneath. If an image is lighter, use a dark play button for accessibility and vice versa.
The video embed element is available in both light and dark themes. It can include either a light or a dark play button, depending on the thumbnail image underneath.

The user is currently responsible for setting the play button color and preventing color contrast issues between the button and the video thumbnail. If an image is on a light color palette or if its video thumbnail image uses mostly light colors, use a light theme play button for accessibility and vice versa.

<div class="grid xs-two-columns">
<uxdot-example width-adjustment="420px">
Expand Down
41 changes: 30 additions & 11 deletions elements/rh-video-embed/docs/20-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,12 @@ The video’s width will dynamically adjust with its parent container. The video

## Best Practices

### Play button

Display the play button in a consistent, predictable spot for all videos.
### Play button position

<div class="grid xs-two-columns">
<uxdot-best-practice variant="do">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../guidelines-best-practice-1-do.svg"
<img src="../video-player-best-practices-btn-position-do.png"
alt="Video with vertically and horizontally centered play button"
width="420"
height="236">
Expand All @@ -75,7 +73,7 @@ Display the play button in a consistent, predictable spot for all videos.

<uxdot-best-practice variant="dont">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../guidelines-best-practice-1-dont.svg"
<img src="../video-player-best-practices-btn-position-dont.png"
alt="Video with play button in the bottom right"
width="420"
height="236">
Expand All @@ -84,16 +82,37 @@ Display the play button in a consistent, predictable spot for all videos.
</uxdot-best-practice>
</div>

### Play button theme

### Aspect Ratio
<div class="grid xs-two-columns">
<uxdot-best-practice variant="do">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../video-player-best-practices-btn-theme-do.png"
alt="Light theme play button layered on a light-colored thumbnail image"
width="420"
height="236">
</uxdot-example>
<p>A light theme play button should be used if the thumbnail image has a light color palette, and a dark theme play button should be used against dark thumbnails.</p>
</uxdot-best-practice>

A video embed element and should have the same aspect ratio as the video it’s displaying.
<uxdot-best-practice variant="dont">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../video-player-best-practices-btn-theme-dont.png"
alt="Dark theme play button layered on a light-colored thumbnail image"
width="420"
height="236">
</uxdot-example>
<p>Do not use a dark theme play button over a thumbnail with mostly light colors, and vice versa.</p>
</uxdot-best-practice>
</div>

### Aspect Ratio

<div class="grid xs-two-columns">
<uxdot-best-practice variant="do">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../guidelines-best-practice-2-do.svg"
alt="Video embed with a correct, 16:9 aspect ratio"
<img src="../video-player-best-practices-aspect-ratio-do.png"
alt="Video embed with a correctly resized thumbnail image"
width="420"
height="237">
</uxdot-example>
Expand All @@ -102,8 +121,8 @@ A video embed element and should have the same aspect ratio as the video it’s

<uxdot-best-practice variant="dont">
<uxdot-example color-palette="lightest" width-adjustment="420px" slot="image">
<img src="../guidelines-best-practice-2-dont.svg"
alt="Video embed with a very narrow aspect ratio"
<img src="../video-player-best-practices-aspect-ratio-dont.png"
alt="Video embed with a narrow aspect ratio, causing the thumbnail to look distorted"
width="420"
height="184">
</uxdot-example>
Expand Down
11 changes: 0 additions & 11 deletions elements/rh-video-embed/docs/guidelines-best-practice-1-do.svg

This file was deleted.

11 changes: 0 additions & 11 deletions elements/rh-video-embed/docs/guidelines-best-practice-1-dont.svg

This file was deleted.

11 changes: 0 additions & 11 deletions elements/rh-video-embed/docs/guidelines-best-practice-2-do.svg

This file was deleted.

12 changes: 0 additions & 12 deletions elements/rh-video-embed/docs/guidelines-best-practice-2-dont.svg

This file was deleted.

7 changes: 6 additions & 1 deletion elements/rh-video-embed/docs/video-active-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions elements/rh-video-embed/docs/video-active-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion elements/rh-video-embed/docs/video-focus-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions elements/rh-video-embed/docs/video-focus-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion elements/rh-video-embed/docs/video-hover-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions elements/rh-video-embed/docs/video-hover-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions elements/rh-video-embed/docs/video-keyboard-navigation.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading