MiniPlayerJS

MiniPlayerJS is a tiny plugin for jQuery that rdisplays a small full-html audio player.

Getting started 🚀

Follow these instructions to use MiniPlayerJS on your project.

Pre-requisites 📋

Make sure you have installed all of the following prerequisites on your development and production machines:

jQuery - Download jQuery. Of course, being a jQuery plugin, MiniPlayerJS needs jQuery to work.

Installation 🔧

Include MiniPlayerJS's .js and .css files on your page:

<link rel="stylesheet" type="text/css" href="miniplayer.css">
<script src="miniplayer.js"></script>

Initialization 📦

The MiniPlayerJS needs to be initiated when the target DOM element is ready. The safest bet is to start it on window onload event or jQuery's document.ready, but it can also be launched on a script tag positioned below the element.

<head>
	<meta charset="utf-8">
	<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
	<script type="text/javascript" src="../src/miniplayer.js"></script>
	<link rel="stylesheet" type="text/css" href="../src/miniplayer.css">
</head>
<body>
	<div id="play_box"></div>
	<script type="text/javascript">

		var song = {
			name: 'Hey',
			author: 'Bensound',
			audio: [{
				src: 'bensound-hey.mp3',
				type: 'audio/mpeg'
			}]
		};

		$("#play_box").miniPlayer(song)

	</script>
</body>

Docs 📖

In this section you can read about the options, events and methods of this plugin.

Options

options.name: `string`

Name of the song that will be displayed on the MiniPlayer.

default: empty

options.author: `string`

Name of the author of the song that will be displayed on the MiniPlayer.

default: empty

options.audio: `array of objects` (required)

Each object in the array represents an audio source and contains:

src string (required): path to the audio resource.
type string (required): media type (‘audio/mpeg’, …)

License (MIT) 📄

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

borjagq/MiniPlayerJS