@xbibzlibrary/alquran
v1.1.3
Published
Quran CDN Library - ESM + UMD build. Compatible with CDN and npm.
Readme
\
🌟 Fitur Utama
Library ini dirancang untuk mempermudah developer dalam mengintegrasikan data Al-Qur'an ke dalam aplikasi web mereka dengan cara yang paling sederhana dan cepat, tanpa perlu backend atau bundler yang rumit.
| Fitur | Deskripsi |
| :--- | :--- |
| 📖 Teks Al-Qur'an | Akses 114 surat dan 6236 ayat lengkap. |
| 💬 Tafsir | Dapatkan tafsir lengkap per surat (Sumber: Kemenag RI). |
| 🎧 Audio & Qori' | Tersedia audio per ayat dari 5 Qori' terbaik dunia. |
| 🚀 CDN Support | Cukup tambahkan <script> tag, dan library siap digunakan secara global. |
| 💡 Ringan & Cepat | Dibangun dengan Webpack untuk ukuran file yang minimal dan performa maksimal. |
🛠️ Cara Kerja
Library ini bekerja sebagai wrapper sederhana untuk API publik Al-Qur'an (api.equran.id/v2). Semua fungsi mengembalikan Promise yang berisi data JSON yang sudah diproses, membuatnya sangat mudah diintegrasikan dengan kode JavaScript modern (async/await).
🚀 Instalasi & Penggunaan
1. Melalui CDN (Cara Termudah)
Ini adalah cara yang paling direkomendasikan untuk penggunaan di browser. Cukup tambahkan tag <script> ini ke dalam file HTML Anda:
<!-- Ganti X.Y.Z dengan versi terbaru yang tersedia di npm/jsdelivr -->
<script src="https://cdn.jsdelivr.net/npm/@xbibzlibrary/alquran@latest/dist/@xbibzlibrary/alquran.min.js"></script>
<script>
// Library akan tersedia secara global sebagai QuranCDN
const quran = new QuranCDN();
// Contoh: Mendapatkan daftar semua surat
quran.getSurahs()
.then(surahs => {
console.log('Total Surat:', surahs.length);
console.log('Surat Pertama:', surahs[0].namaLatin);
})
.catch(error => console.error(error));
</script>2. Melalui NPM (Untuk Project Bundled)
Jika Anda menggunakan bundler seperti Webpack, Rollup, atau Vite:
npm install @xbibzlibrary/alquran
# atau
yarn add @xbibzlibrary/alquranKemudian, impor di kode JavaScript Anda:
import QuranCDN from '@xbibzlibrary/alquran';
const quran = new QuranCDN();
// Contoh: Mendapatkan detail surat ke-18 (Al-Kahf)
quran.getSurahDetail(18)
.then(detail => {
console.log('Nama Surat:', detail.namaLatin);
console.log('Ayat Pertama:', detail.ayat[0].teksArab);
})
.catch(error => console.error(error));📚 Dokumentasi API
Semua fungsi mengembalikan Promise.
| Metode | Parameter | Deskripsi | Contoh Penggunaan |
| :--- | :--- | :--- |
| getSurahs() | - | Mengambil daftar 114 surat. | quran.getSurahs() |
| getSurahDetail(nomor) | nomor (Number, 1-114) | Mengambil detail surat, termasuk semua ayat, terjemahan, dan link audio per ayat. | quran.getSurahDetail(1) |
| getTafsir(nomor) | nomor (Number, 1-114) | Mengambil tafsir lengkap per surat. | quran.getTafsir(114) |
| getQoriList() | - | Mengembalikan array nama 5 Qori' yang tersedia. | quran.getQoriList() |
| getAyahAudioUrl(s, a, q) | s (Surah Number), a (Ayah Number), q (Qori Index, 0-4) | Mengambil URL audio langsung untuk ayat tertentu dari Qori' tertentu. | quran.getAyahAudioUrl(1, 1, 0) |
Daftar Qori' (Index)
| Index | Nama Qori' | | :--- | :--- | | 0 | Abdullah Al-Juhany | | 1 | Abdul Muhsin Al-Qasim | | 2 | Abdurrahman As-Sudais | | 3 | Ibrahim Al-Dossari | | 4 | Misyari Rasyid Al-Afasy |
🤝 Kontribusi & Dukungan
Library ini dibuat oleh XbibzOfficial777. Dukungan Anda sangat berarti!
🔗 Sosial Media
| Platform | Link | | :--- | :--- | | TikTok | tiktok.com/@xbibzofficiall | | YouTube | youtube.com/@XbibzOfficial | | GitHub | github.com/XbibzOfficial777 |
💖 Donasi
Dukung pengembangan lebih lanjut dengan berdonasi:
| Platform | Link | | :--- | :--- | | Saweria | saweria.co/XbibzOfficial | | Ko-Fi | ko-fi/XbibzOfficial |
