icons
icons copied to clipboard
vidstack
Beautifully hand-crafted collection of media icons.
Media Icons
Media Icons is an open-source and beautifully hand-crafted collection of icons, designed by the Vidstack team specifically for building audio and video players. Our icons are bold, clean, and consistent. All of the icons are free for both personal and commercial use.
Usage
The icons can be used in any of the following ways:
- Vidstack Player
- Web Component
- JS Frameworks
- Copy SVG
- Raw SVG
- Raw SVG Paths
- Figma
Vidstack Player
If you're using Vidstack Player, you can use the library as follows with HTML or React.
HTML
Install the package:
npm i media-icons@next
Register the <media-icon> element:
import "vidstack/icons";
Use the element (icons are lazy loaded):
<media-icon type="play"></media-icon>
👉 The complete list of icons can be found in our media icons catalog.
React
Install the package:
npm i media-icons@next
Import icons like so:
import {
PauseIcon,
PlayIcon,
// ...
} from "@vidstack/react/icons";
👉 The complete list of icons can be found in our media icons catalog.
Web Component
You can use the <media-icon> element to lazy load icons via NPM or CDN.
NPM
Install the package:
npm i media-icons@next
Register the <media-icon> element:
import "media-icons/element";
Use the element (icons are lazy loaded):
<media-icon type="play"></media-icon>
👉 The complete list of icons can be found in our media icons catalog.
CDN
Add the following script to the <head> of your site:
<script src="https://cdn.vidstack.io/icons" type="module"></script>
Use the element (icons are lazy loaded):
<media-icon type="play"></media-icon>
👉 The complete list of icons can be found in our media icons catalog.
JS Frameworks
We recommend using unplugin-icons as it has many bundler (Vite/Rollup/Webpack), framework (React/Vue/Preact/Solid/Svelte) and customization options.
First, install the package:
npm i media-icons@next
Next, you'll need to configure the plugin like so:
import { FileSystemIconLoader } from "unplugin-icons/loaders";
Icons({
customCollections: {
media: FileSystemIconLoader("./node_modules/media-icons/raw"),
},
});
Finally, you can import the icons like so:
// Replace {name} with the icon name.
import ... from '~icons/media/{name}';
// Examples
import PauseIcon from '~icons/media/pause';
import PlayIcon from '~icons/media/play';
👉 The complete list of icons can be found in our media icons catalog.
Copy SVG
Head over to the media icons catalog on the Vidstack website, search for an icon, copy the raw SVG, and finally paste it in your project.
Raw SVG
The raw SVG files can be imported from this package like so:
// Replace {name} with the icon name.
import ... from 'media-icons/raw/{name}.svg';
// Examples
import PauseIcon from 'media-icons/raw/pause.svg';
import PlayIcon from 'media-icons/raw/play.svg';
Raw SVG Paths
The raw SVG paths can be imported from this package like so:
// camelCase variant of the icon name
import { pausePaths, playPaths, ... } from 'media-icons';
// All SVG paths (server-side)
import { paths } from "media-icons";
paths.play; // string
paths.pause;
// ...
// Dynamically loaded SVG paths (client-side)
import { lazyPaths } from "media-icons";
lazyPaths.play(); // Promise<string>
lazyPaths.pause();
// ...
It's expected that the SVG paths are inserted into an <svg> element as innerHTML with the
following setup:
<svg
width="32"
height="32"
viewBox="0 0 32 32"
fill="none"
xmlns="http://www.w3.org/2000/svg"
aria-hidden="true"
></svg>
Figma
Our media icons are available on Figma! You can get a copy from the Vidstack community page.
📝 License
Media Icons is MIT licensed.
vidstack