react-responsive-audio-player

see a live demo here

A simple, clean, and responsive visual wrapper for the HTML audio tag, built with React. Give it a playlist and go.

If you're not using npm and you need production-ready scripts to include in your project, check out the releases.

Usage

HTML:

<!DOCTYPE html>
<html>
  <head><link rel="stylesheet" href="audioplayer.css"></head>
  <body>
    <div id="audio_player_container"></div>
    <script src="dist/main.js"></script>
  </body>
</html>

JavaScript (with JSX):

// dist/main.js
var React = require('react');
var ReactDOM = require('react-dom');
var AudioPlayer = require('react-responsive-audio-player');

var playlist =
  [{ url: 'audio/track1.mp3',
     displayText: 'Track 1 by Some Artist' },
   { url: 'audio/track2.mp3',
     displayText: 'Some Other Artist - Track 2' }];
ReactDOM.render(
  <AudioPlayer playlist={playlist} hideBackSkip={true} />,
  document.getElementById('audio_player_container')
);

JavaScript (without JSX):

// dist/main.js
...
ReactDOM.render(
  React.createElement(AudioPlayer, {
    playlist: playlist,
    hideBackSkip: true
  }),
  document.getElementById('audio_player_container')
);

Getting started

Quick start

The fastest way to get off the ground with this module is to paste the following code into an HTML file and open it in a web browser:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>React Responsive Audio Player</title>
    <style> html, body { margin: 0; background: lightseagreen; } </style>
    <!-- audioplayer.css v1.1.2 -->
    <link rel="stylesheet" href="https://cdn.rawgit.com/benwiley4000/react-responsive-audio-player/3d31d4c18c367686ccba011d772a83c49189289c/audioplayer.css">
  </head>
  <body>
    <div id="audio_player_container"></div>

    <!-- react/react-dom served over CDN -->
    <script src="https://unpkg.com/react@15/dist/react.js"></script>
    <script src="https://unpkg.com/react-dom@15/dist/react-dom.js"></script>
    <!-- audioplayer.js v1.1.2 -->
    <script src="https://cdn.rawgit.com/benwiley4000/react-responsive-audio-player/3d31d4c18c367686ccba011d772a83c49189289c/audioplayer.js"></script>
    <script>
      var playlist =
        [{ url: 'song1.mp3', displayText: 'Track 1 - a track to remember' },
         { url: 'song2.ogg', displayText: 'Oggs Oggs Oggs' }];
      ReactDOM.render(
        React.createElement(AudioPlayer, {
          playlist: playlist,
          autoplay: true,
          autoplayDelayInSeconds: 2.1,
          style: { position: 'fixed', bottom: 0 }
        }),
        document.getElementById('audio_player_container')
      );
    </script>
  </body>
</html>

Of course you'll need to include paths to actual audio files, or the player will display and not work.

Package installation

If you use npm and a front-end package bundling system like Browserify or webpack, it's recommended that you install the package and its dependencies in your project:

npm install --save react-responsive-audio-player react react-dom

While react-dom isn't technically a peer dependency, you'll need it if you plan to place the audio player in the DOM, which you probably will.

When you first include the component in your project it might not look how you're expecting. Be sure to check the Styling section below.

Pre-built releases

If you prefer not to use a package bundler, you can find built releases to download here.

Options

Options can be passed to the AudioPlayer element as props. Currently supported props are:

playlist: an array containing urls and display text for each of the tracks you wish to play (see above example for format). undefined by default.
autoplay: a boolean value (true/false) that if true will cause the player to begin automatically once mounted. false by default.
autoplayDelayInSeconds: a number value that represents the number of seconds to wait until beginning autoplay. Will be ignored if autoplay is false. 0 by default. NOTE: Delay is managed by setTimeout and is therefore inexact. If you need to time an autoplay exactly, find a different module that uses the WebAudio API for playback (or fork this one!).
gapLengthInSeconds: a number value that represents the number of seconds to wait at the end of a track before beginning the next one in the playlist. Not applicable for manually-initiated skip. 0 by default. NOTE: Like autoplayDelayInSeconds, this delay is inexact.
hideBackSkip: a boolean value that if true disables the back skip button by hiding it from view. false by default.
hideForwardSkip: a boolean value that if true disables the forward skip button by hiding it from view. false by default.
disableSeek: a boolean value that if true prevents seeking. false by default.
cycle: a boolean value that if true continues playing from the beginning after the playlist has completed. true by default.
stayOnBackSkipThreshold: a number value that represents the number of seconds of progress after which pressing the back button will simply restart the current track. 5 by default.
style: a React style object which is applied to the outermost div in the component. undefined by default.
onMediaEvent: An object where the keys are media event types and the values are callback functions. undefined by default.
audioElementRef: A callback function called after the component mounts and before it unmounts. Similar to React ref callback prop but its only parameter is the internally-referenced HTML audio element, not the component itself. undefined by default. NOTE: This ref should not be used for audio element event listeners; use onMediaEvent.

None of these options are required, though the player will be functionally disabled if no playlist prop is provided.

Styling

IMPORTANT NOTES

In order to use the default stylings you'll need to grab the compiled audioplayer.css sheet from the module's dist/ directory. Again, if you're not using npm, you can get the sheet here.
If you want your audio player to take the full screen width, do the following:
- Include the following code in your own CSS:
```
html,
body {
  margin: 0;
}
```
- Give your audio player fixed position styling, e.g.
```
<AudioPlayer style={{ position: 'fixed', bottom: 0 }} />
```

Why aren't these styles included by default? See this discussion.

The default look:

The default stylings for the audio player can be found here. It's easy to override them with CSS.

To change the font-family for the whole component using CSS, use:

.audio_player {
  font-family: Helvetica, sans-serif;
}

To make the audio player's background color firebrick, use:

.audio_player {
  background-color: #b22222;
}
.audio_player .play_pause_button .triangle_1,
.audio_player .play_pause_button .triangle_2 {
  border-right-color: #b22222;
}

Alternatively, for styles which only affect the outer element, use React inline styles.

Development

For building and testing instructions, see CONTRIBUTING.md.

zizzle6717/react-responsive-audio-player