Fix VideoPlayer accessibility issues (#703)

* improve contrast of VideoPlayer focus styles

* add changeset

* remove overlay from playing video

* improve contrast of VideoPlayer

* fix issue of range tooltip overflowing container

* fix color of custom play icon

* update changeset

* address pr feedback

* fix issue where time tooltip can go out of range

* fix colors after rebase

* hide ControlsBar when video doesn't have focus or mouse

* update snapshots

* hide controls on inactivity

Author: joshfarrant

.changeset/hot-laws-hug.md

@@ -0,0 +1,10 @@
+---
+'@primer/react-brand': patch
+---
+
+`VideoPlayer` accessibility improvements
+
+- Improved contrast of play overlay focus styles.
+- Improved contrast of controls and title.
+- The title bar now hides while the video is playing.
+- The controls bar now hides when the cursor or keyboard focus leaves the video player, or after a few seconds of inactivity, and reappears when the cursor or keyboard focus returns.

packages/design-tokens/src/tokens/functional/components/video-player/colors.js

@@ -16,8 +16,8 @@ module.exports = {
     },
     title: {
       bgColor: {
-        value: 'linear-gradient(#01040966, var(--base-color-scale-transparent))',
-        dark: 'linear-gradient(#01040966, var(--base-color-scale-transparent))',
+        value: 'linear-gradient(180deg, #000000e6, #00000073 66%, transparent)',
+        dark: 'linear-gradient(180deg, #000000e6, #00000073 66%, transparent)',
       },
       fgColor: {
         value: 'var(--base-color-scale-gray-0)',
@@ -26,8 +26,8 @@ module.exports = {
     },
     controls: {
       bgColor: {
-        value: 'linear-gradient(var(--base-color-scale-transparent), #01040966)',
-        dark: 'linear-gradient(var(--base-color-scale-transparent), #01040966)',
+        value: '#000000bf',
+        dark: '#000000bf',
       },
       fgColor: {
         value: 'var(--base-color-scale-gray-0)',
@@ -65,8 +65,8 @@ module.exports = {
           dark: 'var(--base-color-scale-gray-0)',
         },
         progress: {
-          value: 'var(--base-color-scale-blue-5)',
-          dark: 'var(--base-color-scale-blue-5)',
+          value: 'var(--base-color-scale-blue-4)',
+          dark: 'var(--base-color-scale-blue-4)',
         },
       },
     },

packages/react/src/VideoPlayer/VideoPlayer.features.stories.tsx

@@ -7,6 +7,7 @@ import {VideoPlayer} from '.'
 import {Stack} from '../Stack'
 import {Button} from '../Button'
 import {useVideo} from './hooks'
+import styles from './VideoPlayer.stories.module.css'
 
 export default {
   title: 'Components/VideoPlayer/Features',
@@ -98,7 +99,7 @@ export const ControlledProgrammatically = () => {
 }
 
 export const CustomPlayIcon = () => (
-  <VideoPlayer title="GitHub media player" playIcon={() => <PlayIcon size={96} />}>
+  <VideoPlayer title="GitHub media player" playIcon={() => <PlayIcon size={96} className={styles.customPlayIcon} />}>
     <VideoPlayer.Source src="./example.mp4" type="video/mp4" />
     <VideoPlayer.Track src="./example.vtt" default />
   </VideoPlayer>

packages/react/src/VideoPlayer/VideoPlayer.module.css

@@ -19,7 +19,6 @@
 .VideoPlayer__container {
   width: 100%;
   position: relative;
-  overflow: hidden;
   border-radius: var(--brand-borderRadius-medium);
 }
 
@@ -37,7 +36,7 @@
 /* 3. Center Play Button                                      */
 /* ---------------------------------------------------------- */
 
-.VideoPlayer__playButton {
+.VideoPlayer__playButtonOverlay {
   position: absolute;
   top: 0;
   left: 0;
@@ -48,20 +47,21 @@
   z-index: 1;
 }
 
-.VideoPlayer__playButtonOverlay {
+.VideoPlayer__playButtonOverlay.VideoPlayer__playButtonOverlay--transparent {
+  background: transparent;
+}
+
+.VideoPlayer__playButtonOverlay:focus-visible {
+  outline: var(--brand-borderWidth-thicker) solid var(--brand-color-focus);
+  outline-offset: var(--base-size-2);
+}
+
+.VideoPlayer__playButton {
   width: 25%;
   height: 25%;
   max-width: var(--brand-VideoPlayer-playButton-width);
   max-height: var(--brand-VideoPlayer-playButton-height);
   opacity: 0.8;
-}
-
-.VideoPlayer__playButton:focus {
-  border: var(--brand-borderWidth-thick) solid var(--brand-color-focus);
-  box-shadow: 0 0 0 0.125rem var(--brand-color-focus);
-}
-
-.VideoPlayer__playButton svg {
   color: var(--brand-videoPlayer-playButton-fgColor-rest);
 }
 
@@ -73,7 +73,6 @@
   transition: var(--brand-VideoPlayer-transition);
   top: 0;
   position: absolute;
-  border-radius: var(--brand-borderRadius-medium);
   left: 0;
   width: 100%;
   z-index: 2;
@@ -85,6 +84,12 @@
   grid-gap: var(--base-size-12);
   grid-template-columns: auto auto;
   background: var(--brand-videoPlayer-title-bgColor);
+  transition: all var(--brand-animation-duration-fast) var(--brand-animation-easing-default);
+}
+
+.VideoPlayer__title.VideoPlayer__title--hidden {
+  opacity: 0;
+  visibility: hidden;
 }
 
 /* ---------------------------------------------------------- */
@@ -115,8 +120,14 @@
   left: 0;
   width: 100%;
   background: var(--brand-videoPlayer-controls-bgColor);
-  padding: var(--base-size-16) var(--base-size-24);
+  padding: var(--base-size-12) var(--base-size-16);
   pointer-events: all;
+  opacity: 1;
+}
+
+.VideoPlayer__controlsBar--fade {
+  transition: opacity var(--brand-animation-duration-default) var(--brand-animation-easing-default);
+  opacity: 0;
 }
 
 .VideoPlayer__controls:focus,
@@ -228,9 +239,8 @@
 }
 
 .VideoPlayer__rangeInput:focus-visible {
-  border-color: var(--brand-color-focus);
-  outline: none;
-  box-shadow: 0 0 0 0.125rem var(--brand-color-focus);
+  outline: var(--brand-borderWidth-thick) solid var(--brand-color-focus);
+  outline-offset: var(--base-size-4);
   opacity: 1;
 }
 

packages/react/src/VideoPlayer/VideoPlayer.module.css.d.ts

@@ -1,12 +1,15 @@
 declare const styles: {
   readonly "VideoPlayer__container": string;
   readonly "VideoPlayer": string;
-  readonly "VideoPlayer__playButton": string;
   readonly "VideoPlayer__playButtonOverlay": string;
+  readonly "VideoPlayer__playButtonOverlay--transparent": string;
+  readonly "VideoPlayer__playButton": string;
   readonly "VideoPlayer__title": string;
+  readonly "VideoPlayer__title--hidden": string;
   readonly "VideoPlayer__controls": string;
   readonly "VideoPlayer__controls--hidden": string;
   readonly "VideoPlayer__controlsBar": string;
+  readonly "VideoPlayer__controlsBar--fade": string;
   readonly "VideoPlayer__iconControl": string;
   readonly "VideoPlayer__tooltip": string;
   readonly "VideoPlayer__seek": string;

packages/react/src/VideoPlayer/VideoPlayer.stories.module.css

@@ -0,0 +1,3 @@
+.customPlayIcon {
+  color: var(--base-color-scale-white-0);
+}

packages/react/src/VideoPlayer/VideoPlayer.stories.module.css.d.ts

@@ -0,0 +1,5 @@
+declare const styles: {
+  readonly "customPlayIcon": string;
+};
+export = styles;
+

packages/react/src/VideoPlayer/VideoPlayer.tsx

@@ -1,4 +1,4 @@
-import React, {useRef, forwardRef, useContext, type HTMLProps, type FunctionComponent} from 'react'
+import React, {useEffect, useState, useRef, forwardRef, useContext, type HTMLProps, type FunctionComponent} from 'react'
 import clsx from 'clsx'
 import {Text} from '../Text'
 import {type AnimateProps} from '../animation'
@@ -54,7 +54,7 @@ const Root = ({
   showMuteButton = true,
   showVolumeControl = true,
   showFullScreenButton = true,
-  playIcon: PlayIcon = () => <DefaultPlayIcon className={styles.VideoPlayer__playButtonOverlay} />,
+  playIcon: PlayIcon = () => <DefaultPlayIcon className={styles.VideoPlayer__playButton} />,
   ...rest
 }: VideoPlayerProps) => {
   const videoWrapperRef = useRef<HTMLDivElement>(null)
@@ -63,41 +63,84 @@ const Root = ({
   const useVideoContext = useVideo()
   const {ccEnabled, isPlaying, ref, togglePlaying} = useVideoContext
 
-  const hideControls = !isPlaying && !showControlsWhenPaused
+  const [isInteracting, setIsInteracting] = useState(false)
+
+  useEffect(() => {
+    const videoWrapper = videoWrapperRef.current
+    let hideControlsTimeout: NodeJS.Timeout
+    const inactivityTimeout = 3000
+
+    if (!videoWrapper) {
+      return
+    }
+
+    const showControls = () => {
+      setIsInteracting(true)
+
+      clearTimeout(hideControlsTimeout)
+
+      hideControlsTimeout = setTimeout(() => {
+        setIsInteracting(false)
+      }, inactivityTimeout)
+    }
+
+    const hideControls = () => {
+      setIsInteracting(false)
+    }
+
+    videoWrapper.addEventListener('mousemove', showControls)
+    videoWrapper.addEventListener('mouseleave', hideControls)
+    videoWrapper.addEventListener('focusin', showControls)
+    videoWrapper.addEventListener('focusout', hideControls)
+
+    return () => {
+      videoWrapper.removeEventListener('mousemove', showControls)
+      videoWrapper.removeEventListener('mouseleave', hideControls)
+      videoWrapper.removeEventListener('focusin', showControls)
+      videoWrapper.removeEventListener('focusout', hideControls)
+
+      clearTimeout(hideControlsTimeout)
+    }
+  }, [videoWrapperRef])
+
+  const showControls = isInteracting || (showControlsWhenPaused && !isPlaying)
 
   return (
     <div className={styles.VideoPlayer__container} ref={videoWrapperRef}>
       <video ref={ref} title={title} controls={false} className={clsx(styles.VideoPlayer, className)} {...rest}>
         {children}
         <track kind="captions" />
       </video>
-      <div className={styles.VideoPlayer__title}>
-        {showBranding && <MarkGithubIcon size={40} />}
-        {!visuallyHiddenTitle && (
-          <Text size="400" weight="medium" className={styles.VideoPlayer__controlTextColor}>
-            {title}
-          </Text>
-        )}
-      </div>
+      {showBranding || !visuallyHiddenTitle ? (
+        <div className={clsx(styles.VideoPlayer__title, isPlaying && styles['VideoPlayer__title--hidden'])}>
+          {showBranding && <MarkGithubIcon size={40} />}
+          {!visuallyHiddenTitle && (
+            <Text size="400" weight="medium" className={styles.VideoPlayer__controlTextColor}>
+              {title}
+            </Text>
+          )}
+        </div>
+      ) : null}
       <button
-        className={styles.VideoPlayer__playButton}
+        className={clsx(
+          styles.VideoPlayer__playButtonOverlay,
+          isPlaying && styles['VideoPlayer__playButtonOverlay--transparent'],
+        )}
         onClick={togglePlaying}
         aria-label={isPlaying ? 'Pause' : 'Play'}
       >
         {!isPlaying && <PlayIcon />}
       </button>
       <div className={styles.VideoPlayer__controls}>
         {ccEnabled && <Captions />}
-        {!hideControls && (
-          <ControlsBar>
-            {showPlayPauseButton && <PlayPauseButton />}
-            {showSeekControl && <SeekControl />}
-            {showCCButton && <CCButton />}
-            {showMuteButton && <MuteButton />}
-            {showVolumeControl && !isSmall && <VolumeControl />}
-            {showFullScreenButton && <FullScreenButton />}
-          </ControlsBar>
-        )}
+        <ControlsBar className={clsx(!showControls && styles['VideoPlayer__controlsBar--fade'])}>
+          {showPlayPauseButton && <PlayPauseButton />}
+          {showSeekControl && <SeekControl />}
+          {showCCButton && <CCButton />}
+          {showMuteButton && <MuteButton />}
+          {showVolumeControl && !isSmall && <VolumeControl />}
+          {showFullScreenButton && <FullScreenButton />}
+        </ControlsBar>
       </div>
     </div>
   )