Installation

Install Mediabunny using your favorite package manager:

npm

npm install mediabunny

yarn

yarn add mediabunny

pnpm

pnpm add mediabunny

bun

bun add mediabunny

INFO

Requires any JavaScript environment that can run ECMAScript 2021 or later. Mediabunny is expected to be run in modern browsers. For types, TypeScript 5.7 or later is required.

Then, simply import it like this:

import { ... } from 'mediabunny'; // ESM
const { ... } = require('mediabunny'); // or CommonJS

ESM is preferred because it gives you tree shaking.

You can also just include the library using a script tag in your HTML:

<script src="mediabunny.cjs"></script>

This will add a Mediabunny object to the global scope. You can provide types for this global using mediabunny.d.ts.

You can download a built distribution file from the releases page. Use the *.cjs builds for normal script tag inclusion, or the *.mjs builds for script tags with type="module" or direct imports via ESM. Including the mediabunny.d.ts declaration file in your TypeScript project will declare a global Mediabunny namespace.