react-audio-play
is a simple, lightweight and customizable audio player npm package for React applications. It provides an easy-to-use interface to play audio files in your React components with
minimal setup.
- Play audio files in your React application with a single component.
- Control playback with play, pause, stop, and volume adjustment functionality.
- Display track progress with a customizable progress bar.
- Trigger custom actions on audio events like onPlay, onPause, onStop, onEnd, etc.
- Fully customizable appearance to match your application's design.
Check examples
You can install react-audio-play
using npm or yarn:
npm install react-audio-play
or
yarn add react-audio-play
To use react-audio-play
, import the AudioPlayer
component and provide the necessary props:
import React from 'react';
import { AudioPlayer } from 'react-audio-play';
const App = () => {
return (
<div>
<h1>My Audio Player</h1>
<AudioPlayer src="path/to/audio.mp3" />
</div>
);
};
export default App;
They can be turned off by setting hasKeyBindings
prop to false
Key binding | Action |
---|---|
Space | Play/Pause |
← | Rewind |
→ | Forward |
↑ | Volume up |
↓ | Volume down |
react-audio-play
accepts the following props:
className
(string, optional): A CSS class name for styling the component.src
(string, required): The URL or file path of the audio file to be played.autoPlay
(boolean, optional): Set this totrue
to autoplay the audio. Default isfalse
.preload
(string, optional): Specifies the preload behavior for the audio file. Possible values are:auto
: The audio data is loaded as soon as possible.metadata
: Only metadata (e.g., duration) is loaded.none
: No preloading. Audio data is only loaded when requested.
loop
(boolean, optional): Set this totrue
to enable looping of the audio playback. Default isfalse
.volume
(number, optional): The initial volume level of the audio, ranging from 0 to 100. Default is100
.hasKeyBindings
(boolean, optional): Specifies whether theAudioPlayer
component should enable keyboard shortcuts for volume control and seeking. Default istrue
.onPlay
(function, optional): Callback function to execute when the audio starts playing.onPause
(function, optional): Callback function to execute when the audio is paused.onEnd
(function, optional): Callback function to execute when the audio playback ends.onError
(function, optional): Callback function to execute if there's an error loading or playing the audio.backgroundColor
(string, optional): The background color of the audio player. Default is#fff
.color
(string, optional): The text and icon color of the audio player. Default is#566574
.sliderColor
(string, optional): The color of the progress slider. Default is#007FFF
.volumePlacement
(string, optional): Specifies the placement of the volume controls. Possible values aretop
andbottom
. Default istop
.width
(string, optional): The width of the audio player. Use this prop to set the width of the player. For example,"100%"
,"300px"
, etc.style
(object, optional): An object containing additional inline styles for the component.
Starting with version v1.0.4
, you can access certain actions of the AudioPlayer
component programmatically using a ref
with the following interface:
play
: Function to start audio playback.pause
: Function to pause audio playback.stop
: Function to stop the audio playback.focus
: Function to focus on the audio player component.
import { useRef } from 'react';
import { AudioPlayer, AudioPlayerRef } from 'react-audio-play';
function App() {
const playerRef = useRef<AudioPlayerRef>(null);
const handlePlay = () => {
playerRef.current?.play();
};
const handlePause = () => {
playerRef.current?.pause();
};
const handleStop = () => {
playerRef.current?.stop();
};
const handleFocus = () => {
playerRef.current?.focus();
};
return (
<div>
<AudioPlayer ref={playerRef} src="path/to/audio.mp3" autoPlay />
<button onClick={handlePlay}>Play</button>
<button onClick={handlePause}>Pause</button>
<button onClick={handleStop}>Stop</button>
<button onClick={handleFocus}>Focus</button>
</div>
);
}
import React from 'react';
import { AudioPlayer } from 'react-audio-play';
const App = () => {
const handlePlay = () => {
console.log('Audio started playing');
};
const handlePause = () => {
console.log('Audio paused');
};
return (
<div>
<h1>My Audio Player</h1>
<AudioPlayer src="path/to/audio.mp3" onPlay={handlePlay} onPause={handlePause} />
</div>
);
};
export default App;
You can easily customize the appearance of the audio player by applying your CSS styles to the AudioPlayer component or by overriding the default styles in your project's CSS. Check examples
This package is open-source and distributed under the MIT License. See the LICENSE file for details.
Contributions are welcome! If you find any issues or have suggestions, feel free to create an issue or submit a pull request on the GitHub repository. Let's build this package together!
Enjoy using react-audio-play in your React applications, and we hope it enhances your audio experience with ease and flexibility. If you have any questions or need further assistance, don't hesitate to reach out to us! Happy coding! 🎶