@javaabu/dhivehigpt-player
v1.1.0
Published
Lightweight, dependency-free custom audio player for DhivehiGPT-generated read-aloud audio, embeddable on any website
Readme
DhivehiGPT Player
A lightweight, dependency-free audio player for DhivehiGPT-generated "read aloud" audio. Turns a plain <audio> tag into a branded control bar, embeddable on any website — no build step required. Built for modern evergreen browsers (Safari 10.1+/Chrome 58+/Firefox 52+/Edge 15+ — see requirements).
Documentation
Full documentation: docs.javaabu.com/docs/dhivehigpt-player-js
Find yourself stuck using the package? Found a bug? Feel free to create an issue on GitHub, we'll try to address it as soon as possible.
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Install
npm install @javaabu/dhivehigpt-player --saveOr, with no build step at all, via jsDelivr:
<script src="https://cdn.jsdelivr.net/npm/@javaabu/dhivehigpt-player/dist/dhivehigpt-player.umd.min.js"></script>Or download it and self-host: the same file is committed at dist/dhivehigpt-player.umd.min.js in this repo.
Basic usage
Add data-dhivehigpt-player to a standard <audio> tag — it's converted automatically:
<audio data-dhivehigpt-player src="https://example.com/article.mp3"></audio>Options are set via data-* attributes, e.g. data-dark="true", data-accent="true", data-sticky="true". See the data-attributes reference for the full list.
Or initialize programmatically:
import { AudioPlayer } from '@javaabu/dhivehigpt-player';
const player = new AudioPlayer('#my-audio', { accent: true, sticky: true });
player.on('play', () => console.log('playing'));React, Vue, Svelte, and jQuery integrations are available at @javaabu/dhivehigpt-player/react, /vue, /svelte, and /jquery (each a separate entry, so the core bundle only ships what you actually use). Angular, Alpine.js, and Laravel Livewire are supported too — see the framework guides for details.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
