@videojs/icons
SVG icon library for Video.js. Ships optimized icons for React, React Native, HTML strings, static rendering, and the <media-icon> custom element, organized into icon sets.
Icon Sets
Icons are grouped into visual sets. Each set contains the same icon names with different designs.
| Set | Description |
|---|---|
default |
Standard icon set used by the default skin |
neutral |
Simplified icon set used by the neutral skin |
compat |
Icon set used by the compat skin |
Available Icons
| Icon | React Export | HTML Export |
|---|---|---|
airplay-enter |
AirPlayEnterIcon |
airPlayEnterIcon |
airplay-exit |
AirPlayExitIcon |
airPlayExitIcon |
captions-off |
CaptionsOffIcon |
captionsOffIcon |
captions-on |
CaptionsOnIcon |
captionsOnIcon |
cast-enter |
CastEnterIcon |
castEnterIcon |
cast-exit |
CastExitIcon |
castExitIcon |
check |
CheckIcon |
checkIcon |
chevron |
ChevronIcon |
chevronIcon |
error |
ErrorIcon |
errorIcon |
fullscreen-enter |
FullscreenEnterIcon |
fullscreenEnterIcon |
fullscreen-exit |
FullscreenExitIcon |
fullscreenExitIcon |
gear |
GearIcon |
gearIcon |
pause |
PauseIcon |
pauseIcon |
pip-enter |
PipEnterIcon |
pipEnterIcon |
pip-exit |
PipExitIcon |
pipExitIcon |
play |
PlayIcon |
playIcon |
quality |
QualityIcon |
qualityIcon |
restart |
RestartIcon |
restartIcon |
seek |
SeekIcon |
seekIcon |
speech |
SpeechIcon |
speechIcon |
speed |
SpeedIcon |
speedIcon |
spinner |
SpinnerIcon |
spinnerIcon |
switches |
SwitchesIcon |
switchesIcon |
volume-high |
VolumeHighIcon |
volumeHighIcon |
volume-low |
VolumeLowIcon |
volumeLowIcon |
volume-off |
VolumeOffIcon |
volumeOffIcon |
Usage
React
Import icons as React components. They accept standard SVG props and support ref forwarding.
import { PlayIcon, PauseIcon } from '@videojs/react/icons';
function Controls() {
return (
<button>
<PlayIcon className="icon" aria-hidden="true" />
</button>
);
}
Import from a specific icon set:
import { PlayIcon } from '@videojs/react/icons/neutral';
React Native
Import icons as react-native-svg components, built from the same SVG sources as the React icons. They accept SvgProps and support ref forwarding.
import { PlayIcon } from '@videojs/icons/react-native';
import { PlayIcon as NeutralPlayIcon } from '@videojs/icons/react-native/neutral';
<PlayIcon color="white" width={24} height={24} />;
react-native-svg has no stylesheet support, so icons that animate through CSS, such as spinner, render static. Animate them from the component that renders them.
HTML
Import icons as SVG strings for use in plain HTML or web components.
import { playIcon, pauseIcon } from '@videojs/html/icons';
button.innerHTML = playIcon;
Import from a specific icon set:
import { playIcon } from '@videojs/html/icons/neutral';
Register the <media-icon> custom element separately when you want HTML skins to render icons lazily:
import '@videojs/html/icons/element';
Import a specific element icon set when eager family registration is preferred:
import '@videojs/html/icons/element/neutral';
Styling
All icons use fill="currentColor", so they inherit the text color of their parent element. Size and color can be controlled with CSS:
.icon {
width: 18px;
height: 18px;
color: white;
}
Icons are designed on an 18×18 grid. Rendering at 18px (or exact multiples like 36px) produces the crispest result. Other sizes may introduce sub-pixel rendering artifacts.
Adding Icons
- Add an SVG file to
src/assets/<set>/(e.g.,src/assets/default/my-icon.svg). - Run
pnpm -F @videojs/icons build. - The build script optimizes the SVG with SVGO and generates React, React Native, and HTML string exports.
The build automatically:
- Optimizes each source SVG once and normalizes black fills and strokes to
currentColor. - Adds
aria-hidden="true"because accessible names belong on the surrounding control. - Preserves the
viewBoxattribute. - Generates executable
.jsmodules and matching.d.tsdeclarations.
Adding an Icon Set
Create a new directory under src/assets/ (e.g., src/assets/custom/), add SVG files, and rebuild. The set is automatically available via:
import { PlayIcon } from '@videojs/react/icons/custom';
import { playIcon } from '@videojs/html/icons/custom';
Development
Running pnpm -F @videojs/icons dev starts the build in watch mode. Any changes to .svg files under src/assets/ trigger an automatic rebuild, including new icons and new icon sets — no restart required.
Scripts
pnpm -F @videojs/icons build # Build all icon sets
pnpm -F @videojs/icons dev # Build and watch for changes
pnpm -F @videojs/icons clean # Remove build output