Skip to main content

Installation

Webamp can be installed from NPM or included via a script tag using a a free content delivery network (CDN) such as unpkg.

warning

Keep in mind that if you choose to use a free CDN, that CDN may stop operating at any time. If possible, consider downloading the file and serving it from your own server.

Install via NPM​

npm install --save webamp

From here you can import Webamp in your JavaScript code:

import Webamp from "webamp";
// ... use Webamp here

Import directly from a CDN​

ES modules can be imported via URL directly inside a <script type="module"> tag.

<script type="module">
  import Webamp from "https://unpkg.com/webamp@^2";
  // ... use Webamp here
</script>

Include via a script tag​

This will make the Webamp constructor available as a window property: window.Webamp keep in mind that you will need to use the type="module" attribute on the script tag,

<script src="https://unpkg.com/webamp@^2" type="module"></script>
<script>
  const Webamp = window.Webamp;
  // ... use Webamp here
</script>