alfurqan 0.0.1

Al Quran verses, translations, juzs and chapters. Offline.

example/main.dart

import 'package:alfurqan/alfurqan.dart';

void main(List<String> args) {
  final basmallah = AlQuran.basmallah;
  print(basmallah); // بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ

  final totalJuz = AlQuran.totalJuz;
  print(totalJuz); // 30

  final totalChapter = AlQuran.totalChapter;
  print(totalChapter); // 114

  final totalMadani = AlQuran.totalMadaniSurah;
  print(totalMadani); // 28

  final totalMakki = AlQuran.totalMakkiSurah;
  print(totalMakki); // 86

  final totalVerse = AlQuran.totalVerse;
  print(totalVerse); // 6236

  final juz = AlQuran.getJuz(1, 1);
  print(juz);
  // Juz(
  //   verse: JuzVerse(
  //     first: 1,
  //     last: 148,
  //     count: 148,
  //     items: {
  //       1: 1-7,
  //       2: 1-141
  //     }
  //   ),
  //   id: 1,
  //   number: 1
  // )

  final chapter = AlQuran.getChapter(1);
  print(chapter);
  // Chapter(
  //   id: 1,
  //   bismillahPre: false,
  //   nameArabic: "الفاتحة",
  //   nameComplex: "Al-Fātiĥah",
  //   nameSimple: "Al-Fatihah",
  //   pages: [1, 1],
  //   revelationOrder: 5,
  //   revelationPlace: ChapterRevelationPlace.makkah,
  //   translatedName: {
  //     id: "Pembukaan",
  //     en: "The Opener",
  //     ar: "سورة الفاتحة",
  //     tr: "Fâtiha",
  //     fr: "Louverture"
  //   },
  //   versesCount: 7
  // )

  final verse = AlQuran.getVerse(1, 1);
  print(verse);
  // Verse(
  //   id: 1,
  //   verseKey: "1:1",
  //   text: "بِسۡمِ اللهِ الرَّحۡمٰنِ الرَّحِيۡمِ",
  //   chapterID: 1,
  //   pageNumber: 1,
  //   juzNumber: 1
  // );

  final verseWithMode = AlQuran.getVerse(
    1,
    1,
    mode: VerseMode.uthmani,
  );
  print(verseWithMode);
  // Verse(
  //   id: 1,
  //   verseKey: "1:1",
  //   text: "بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ",
  //   chapterID: 1,
  //   pageNumber: 1,
  //   juzNumber: 1,
  // )

  final translation = AlQuran.getTranslation(
      TranslationType.idIndonesianIslamicAffairsMinistry, "1:1");
  print(translation);
  // VerseTranslation(
  //   id: 181444,
  //   verseKey: "1:1",
  //   text: "Dengan nama Allah Yang Maha Pengasih, Maha Penyayang.",
  //   resourceID: 33,
  //   languageName: "indonesian"
  // )

  final chapterAudio = AlQuran.getAudioURLByChapter(1);
  print(
      chapterAudio); // https://cdn.islamic.network/quran/audio-surah/128/ar.alafasy/1.mp3

  // With Edition
  final chapterAudioWithEdition = AlQuran.getAudioURLByChapter(
    1,
    edition: AudioEdition.ar_husary,
  );
  print(
      chapterAudioWithEdition); // https://cdn.islamic.network/quran/audio-surah/128/ar.husary/1.mp3

  final verseAudio = AlQuran.getAudioURLByVerse(1);
  print(
      verseAudio); // https://cdn.islamic.network/quran/audio/128/ar.alafasy/1.mp3

  // With Edition
  final verseAudioWithEdition =
      AlQuran.getAudioURLByVerse(1, edition: AudioEdition.ar_husary);
  print(
      verseAudioWithEdition); // https://cdn.islamic.network/quran/audio/128/ar.husary/1.mp3

  final imageUrl = AlQuran.getImageURLByVerse("1:1");
  print(imageUrl); // https://cdn.islamic.network/quran/images/1_1.png

  // With high quality
  final imageUrlHighQuality =
      AlQuran.getImageURLByVerse("1:1", highQuality: true);
  print(
      imageUrlHighQuality); // https://cdn.islamic.network/quran/images/high-resolution/1_1.png
}