Atrium // Components
Video
A video player with custom controls, built on Video.js.
The Video component plays a video file with our own controls: play/pause, time, a seek bar, mute, volume and fullscreen.
The controls are the unstyled a-media-* elements, styled with Tailwind and Atrium icons. Video.js (<video-player>, <media-container>) adds fullscreen, gestures, hotkeys and auto hiding controls.
Controls hide while the video plays and the pointer is idle, and show again on pointer movement, focus or pause.
Requires the @videojs/html package.
<script setup lang="ts">
import "@atrium-ui/elements/media";
import "@videojs/html/video/player";
import "@videojs/html/ui/container";
import "@videojs/html/ui/controls";
import "@videojs/html/ui/fullscreen-button";
import "@videojs/html/ui/gesture";
import "@videojs/html/ui/hotkey";
import "@videojs/html/ui/status-indicator";
import { twMerge } from "tailwind-merge";
import Icon from "./Icon.vue";
const props = defineProps<{
src: string;
label: string;
poster?: string;
class?: string;
}>();
</script>
<template>
<video-player class="contents">
<a-media class="contents">
<media-container
:aria-label="label"
:class="
twMerge(
'relative block aspect-video w-full overflow-hidden rounded-md bg-black font-sans text-white focus-visible:outline-2 focus-visible:outline-zinc-900 focus-visible:outline-offset-2',
props.class,
)
"
>
<video
:src="src"
:poster="poster"
playsinline
preload="metadata"
class="block h-full w-full object-contain"
>
<slot />
</video>
<media-gesture type="tap" action="togglePaused" />
<media-gesture type="doubletap" action="toggleFullscreen" />
<media-hotkey keys="Space" action="togglePaused" />
<media-hotkey keys="k" action="togglePaused" />
<media-hotkey keys="m" action="toggleMuted" />
<media-hotkey keys="f" action="toggleFullscreen" />
<media-hotkey keys="ArrowLeft" action="seekStep" value="-5" />
<media-hotkey keys="ArrowRight" action="seekStep" value="5" />
<media-status-indicator
actions="togglePaused toggleMuted"
aria-hidden="true"
class="group/status pointer-events-none absolute top-1/2 left-1/2 grid h-16 w-16 -translate-1/2 place-items-center rounded-full bg-black/50 text-3xl transition-[opacity,scale] duration-500 ease-out data-ending-style:scale-125 data-ending-style:opacity-0 data-starting-style:scale-75 data-starting-style:opacity-0 [&[hidden]]:hidden"
>
<Icon name="play" class="hidden group-data-[status=play]/status:block" />
<Icon name="pause" class="hidden group-data-[status=pause]/status:block" />
<Icon name="volume" class="hidden group-data-[status=volume-low]/status:block group-data-[status=volume-high]/status:block" />
<Icon name="volume-off" class="hidden group-data-[status=volume-off]/status:block" />
</media-status-indicator>
<media-controls
class="pointer-events-none absolute inset-x-0 bottom-0 bg-linear-to-t from-black/70 to-transparent px-4 pt-16 pb-3 transition-opacity duration-300 has-[:focus-visible]:opacity-100 [&:not([data-visible])]:opacity-0"
>
<div role="group" aria-label="Video controls" data-interactive class="pointer-events-auto">
<a-media-seek
label="Seek"
class="block w-full [--range-handle-background:white] [--range-handle-size:0.75rem] [--range-outline-color:white] [--range-progress-background:white] [--range-track-background:rgb(255_255_255/0.6)] [--range-track-padding:0.5rem_0] [--range-track-height:0.1875rem] hover:[--range-track-height:0.3125rem] [&::part(handle)]:origin-top-left [&::part(handle)]:scale-0 [&::part(handle)]:transition-[scale] hover:[&::part(handle)]:scale-100 focus-within:[&::part(handle)]:scale-100"
/>
<div class="flex items-center gap-1 text-lg">
<a-media-play class="grid h-9 w-9 flex-none place-items-center rounded-md transition-colors hover:bg-white/15 focus-visible:outline-2 focus-visible:outline-white focus-visible:-outline-offset-2 active:bg-white/25 active:transition-none [&>span]:flex">
<span slot="play"><Icon name="play" /><span class="sr-only">Play</span></span>
<span slot="pause"><Icon name="pause" /><span class="sr-only">Pause</span></span>
</a-media-play>
<div class="group/volume flex items-center">
<a-media-mute class="grid h-9 w-9 flex-none place-items-center rounded-md transition-colors hover:bg-white/15 focus-visible:outline-2 focus-visible:outline-white focus-visible:-outline-offset-2 active:bg-white/25 active:transition-none [&>span]:flex">
<span slot="mute"><Icon name="volume" /><span class="sr-only">Mute</span></span>
<span slot="unmute"><Icon name="volume-off" /><span class="sr-only">Unmute</span></span>
</a-media-mute>
<a-media-volume
label="Volume"
class="w-0 opacity-0 transition-[width,opacity,margin] duration-200 group-focus-within/volume:mx-2 group-focus-within/volume:w-16 group-focus-within/volume:opacity-100 group-hover/volume:mx-2 group-hover/volume:w-16 group-hover/volume:opacity-100 [--range-handle-background:white] [--range-handle-size:0.75rem] [--range-outline-color:white] [--range-progress-background:white] [--range-track-background:rgb(255_255_255/0.6)] [--range-track-padding:0.5rem_0] [--range-track-height:0.25rem]"
/>
</div>
<div class="mx-1 flex-none text-sm text-white/90">
<a-media-time type="current" />
<span class="mx-1 text-white/60">/</span>
<a-media-time type="duration" class="text-white/60" />
</div>
<media-fullscreen-button class="group/fullscreen ml-auto grid h-9 w-9 flex-none place-items-center rounded-md transition-colors hover:bg-white/15 focus-visible:outline-2 focus-visible:outline-white focus-visible:-outline-offset-2 active:bg-white/25 active:transition-none [&[hidden]]:hidden">
<Icon name="fullscreen" class="group-data-fullscreen/fullscreen:hidden" />
<Icon name="fullscreen-exit" class="hidden group-data-fullscreen/fullscreen:block" />
</media-fullscreen-button>
</div>
</div>
</media-controls>
</media-container>
</a-media>
</video-player>
</template> Examples
Default
Pass a src and a descriptive label. Any children (<source>, <track>) are placed inside the <video> element.
Poster
Use poster to show an image before playback starts.
Feature
A common use case: a video next to a short description. Class names on the component are merged into the player container, e.g. for rounding or shadows.
<div class="grid w-full max-w-4xl items-center gap-8 md:grid-cols-[1fr_1.6fr]">
<div class="font-sans">
<div class="text-xs text-zinc-500 uppercase tracking-[0.14em]">Showreel</div>
<h3 class="mt-2 mb-4 text-2xl text-zinc-900">Made with Atrium</h3>
<p class="text-zinc-600 leading-relaxed">
A short look at what we built this year. Press play, or focus the player and use the keyboard.
</p>
</div>
<Video class="rounded-xl shadow-xl" src="/showreel.mp4" poster="/showreel.webp" label="Atrium showreel" />
</div> Guidelines
- Don't autoplay with sound: Browsers block it and it surprises users. If a video has to start on its own, it must be muted.
- Provide a poster: It reserves the frame with meaningful content and avoids a black box before the first frame loads.
- Captions: Add a
<track kind="captions">for videos with speech. - Layout shifts: The player reserves its space with an aspect ratio (16/9 by default) before the video or the custom elements load, also when rendered on the server.
Match it to your video with a class like
aspect-squareoraspect-[4/5], otherwise the video is letterboxed. Times are padded to the length of the duration, so the controls don't shift during playback. - Streaming: For HLS or DASH sources, attach a library like hls.js to the
<video>element. The controls only work with native<video>elements.
Accessibility
- Label: The
labelprop names the player for screen readers. Describe the content of the video. - Controls: All controls are focusable buttons and sliders with accessible names. Focusing a control keeps the controls visible.
- Keyboard: When the player is focused, Space/K toggles playback, M mutes, F toggles fullscreen and ←/→ seek 5 seconds.
- Pointer: Click the video to play or pause, double click to toggle fullscreen.