1.0.93 β€’ Published 2 years ago

react-simplified-player v1.0.93

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

πŸ“¦ Installation

using npm:

npm i react-simplified-player

using yarn:

yarn add react-simplified-player

πŸ–ΌοΈ Screenshots

Desktop

Mobile

✨ Feature list

  • Playlist
  • Color Customize
  • API props
  • Typescript support

πŸ‘€ Example

Live Demo:

https://react-simplified-player.netlify.app/

How things work

Source Code

πŸ“ Usage

import ReactDOM from "react-dom/client";
const rootElement = document.getElementById("root") as HTMLElement
const root = ReactDOM.createRoot(rootElement);

import { ReactSimplifiedPlayer } from "react-simplified-player"

root.render(<ReactSimplifiedPlayer {...props} />);

πŸ“„ API

NameTypeDefaultRequiredDescription
mainColorstring-βœ…main color shows the background of draggable player
showQueuebooleanfalseshowing queue on player
songQueueType-βœ…which song must be added to queue or which one should play, if you dont have music yet just put there boilerplate
defaultVolume0-10.5when page loads default volume of playing song
onVolumeChange(volume: string) => void-when you change volume it triggers volume parameter and shows volume level 0-1
onAudioPlay(currentSong: QueueType)=> void-when you click play of song it currentSong show object of what song is playing right now
onAudioPause(currentSong: QueueType)=> void-when you click pause of song it currentSong show object of what song is playing right now
onAudioEnded(currentSong: QueueType)=> void-when audio ends shows which audio ended as object
onForward(currentSong: QueueType)=> void-when you click next button it shows which is upcomming song as object
onBack(currentSong: QueueType)=> void-when you click previous button it shows which is upcomming song as object

πŸ’‘ Customizeble UI

  • color
  • showing queue

custom color

import ReactDOM from "react-dom/client";
const rootElement = document.getElementById("root") as HTMLElement
const root = ReactDOM.createRoot(rootElement);

import { ReactSimplifiedPlayer } from "react-simplified-player"

// 🟑
root.render(<ReactSimplifiedPlayer mainColor={"#fcba03"} {...props} />);

show queue

import ReactDOM from "react-dom/client";
const rootElement = document.getElementById("root") as HTMLElement
const root = ReactDOM.createRoot(rootElement);

import { ReactSimplifiedPlayer } from "react-simplified-player"

// 🟑
root.render(<ReactSimplifiedPlayer showQueue={true} {...props} />);

πŸ‘¨β€πŸ’» Installation

git clone https://github.com/callmenikk/react-simplified-player.git
cd react-simplified-player

npm i
npm start

🟦Component Prop Types

interface PlayerProps {
	mainColor: string,
	queue?:boolean,
	song?: QueueType,
	defaultVolume?: number,
	showQueue?: boolean,
	onVolumeChange?: (volume: number) => void,
	onAudioPlay?: (currentSong: QueueType) => void
	onAudioPause?: (currentSong: QueueType) => void,
	onAudioEnded?: (currentSong: QueueType) => void,
	onForward?: (currentSong: QueueType) => void,
	onBack?: (currentSong: QueueType) => void
}

🎢🟦Song Type

interface QueueType {
	song_cover?: string;
	song_title?: string;
	id?: string
	song_artist?: string;
	url: string;
}

πŸ“„ License

MIT

1.0.93

2 years ago

1.0.92

2 years ago

1.0.91

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.78

2 years ago

1.0.77

2 years ago

1.0.76

2 years ago

1.0.75

2 years ago

1.0.74

2 years ago

1.0.73

2 years ago

1.0.72

2 years ago

1.0.71

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

0.0.2

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.1.0

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago