@splicemood/react-music-player
v1.0.9
Published
The music player that sync all settings between multiple tabs on single browser session locally
Downloads
233
Readme
About The Project
Web browsers compatibility (Can I Use >96%)
Built With
Getting Started
You need to setup provider and hook in your react app
Prerequisites
Install dependency
npm
npm i @splicemood/react-music-player
bun
bun i @splicemood/react-music-player
Installation
main.tsx
import ReactDOM from 'react-dom/client';
import App from './App';
import { PlayerFullSyncProvider } from '@splicemood/react-music-player';
ReactDOM.createRoot(document.getElementById('root')!).render(
<PlayerFullSyncProvider>
<App />
</PlayerFullSyncProvider>
);
Player.tsx
import { useAudio } from "@splicemood/react-music-player"
const Player = () => {
const audio = useAudio()
// your component visualization using the hook
};
export default Player;
Usage
For more examples, please refer to the GitHub Page of the project
Roadmap
- [x] Full tab synchronization provider
- [x] Play/Pause tab synchronization provider
- [x] No sync provider
See the open issues for a full list of proposed features (and known issues).
Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Top contributors:
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Kirill Bogomolov - @manazoid - [email protected]
Project Link: https://github.com/splicemood/react-music-player