alfurqan 0.0.3

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

Al Furqan

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

Features

• Offline 🚀. Use it locally, not need to fetch from internet.
• Multiple verse text mode available
  • indopak
  • uthmani
  • uthmani tajweed
  • imlaei
• Chapter translated names (🇮🇩, 🇬🇧, 🇸🇦, 🇹🇷, 🇫🇷)
• Chapter revelations
• Verse translations
  • 🇮🇩: Indonesian Islamic Affairs Ministry
  • 🇬🇧: MAS Abdel Haleem
  • 🇹🇷: Dar Al-Salam Center
  • 🇫🇷: Montada Islamic Foundation
• Generate URL for Audio and Image. Based on Islamic Network.
• Generate Random Verse
• Search Chapters or Verses
• Verses by Juz or Chapter

Install

1. Add alfurqan as a dependency in your pubspec.yaml.

   dependencies:
     alfurqan: any
   

2. Install it

   flutter pub get
   

3. And import it

   import 'package:alfurqan/alfurqan.dart';
   

Usage

• Basmallah

  final basmallah = AlQuran.basmallah;
  print(basmallah); // بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ
  

• Total Juz

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

• Total Chapter

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

• Total Madani

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

• Total Makki

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

• Total Verse

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

• Juz

  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
  // )
  

• Chapter

  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
  // )
  

• Verse

  final verse = AlQuran.getVerse(1, 1);
  print(verse);
  // Verse(
  //   id: 1,
  //   verseKey: "1:1",
  //   text: "بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ",
  //   chapterID: 1,
  //   pageNumber: 1,
  //   juzNumber: 1
  // );
  
  // With Mode. Available indopak, uthmani, uthmani tajweed, and imlaei.
  final verseWithMode = AlQuran.getVerse(
    1,
    1,
    mode: VerseMode.uthmani,
  );
  print(verseWithMode);
  // Verse(
  //   id: 1,
  //   verseKey: "1:1",
  //   text: "بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ",
  //   chapterID: 1,
  //   pageNumber: 1,
  //   juzNumber: 1,
  // )
  
  // By Juz
  final versesByJuz = AlQuran.versesByJuz(1);
  print("""
    VersesByJuz
    Verses: ${versesByJuz.length}
  """);
  //  VersesByJuz
  //  Verses: 148
  
  // By Chapter
  final versesByChapter = AlQuran.versesByChapter(1);
  print("""
    VersesByChapter
    Verses: ${versesByChapter.length}
  """);
  //  VersesByChapter
  //  Verses: 7
  

• Translation

  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"
  // )
  

• Chapter Audio URL

  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
  

• Verse Audio URL

  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
  

• Verse Image URL

  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
  

• Random Verse

  final randomVerse = AlQuran.randomVerse();
  print("""
    RandomVerse
    Verse: ${randomVerse?.verse.toJson()}
    Trans: ${randomVerse?.translation.toJson()}
  """);
  //  RandomVerse
  //  Verse: {
  //    id: 3247,
  //    verseKey: 27:88,
  //    text: "وَتَرَى الۡجِبَالَ تَحۡسَبُهَا جَامِدَةً وَّهِىَ تَمُرُّ مَرَّ السَّحَابِ​ؕ صُنۡعَ اللّٰهِ الَّذِىۡۤ اَتۡقَنَ كُلَّ شَىۡءٍ​ؕ اِنَّهٗ خَبِيۡرٌۢ بِمَا تَفۡعَلُوۡنَ",
  //    chapterID: 27,
  //    pageNumber: 384,
  //    juzNumber: 20
  //  }
  //  Trans: {
  //    id: 404950,
  //    verseKey: 27:88,
  //    text: "You will see the mountains and think they are firmly fixed, but they will float away like clouds: this is the handiwork of God who has perfected all things. He is fully aware of what you do:",
  //    resourceID: 85,
  //    languageName: "english"
  //  }
  
  // With mode and translation
  final randomVerseWithMode = AlQuran.randomVerse(
    mode: VerseMode.uthmani,
    translationType: TranslationType.idIndonesianIslamicAffairsMinistry,
  );
  print("""
    RandomVerseWithMode
    Verse: ${randomVerseWithMode?.verse.toJson()}
    Trans: ${randomVerseWithMode?.translation.toJson()}
  """);
  //  RandomVerseWithMode
  //  Verse: {
  //    id: 1648,
  //    verseKey: "12:52",
  //    text: ذَٰلِكَ لِيَعْلَمَ أَنِّى لَمْ أَخُنْهُ بِٱلْغَيْبِ وَأَنَّ ٱللَّهَ لَا يَهْدِى كَيْدَ ٱلْخَآئِنِينَ,
  //    chapterID: 12,
  //    pageNumber: 241,
  //    juzNumber: 12
  //  }
  //  Trans: {
  //    id: 181655,
  //    verseKey: "12:52",
  //    text: "(Yusuf berkata), Yang demikian itu agar dia (Al-Aziz) mengetahui bahwa aku benar-benar tidak mengkhianatinya ketika dia tidak ada (di rumah), dan bahwa Allah tidak meridai tipu daya orang-orang yang berkhianat.",
  //    resourceID: 33,
  //    languageName: "indonesian"
  //  }
  

• Search

  final searchResult = AlQuran.search(
    'annas',
    TranslationType.idIndonesianIslamicAffairsMinistry,
  );
  
  print("""
    SearchResult
    Chapters: ${searchResult.chapters}
    Verses: ${searchResult.verses}
  """);
  
  //  SearchResult
  //  Chapters: [
  //    Chapter(
  //      id: 36,
  //      bismillahPre: true,
  //      nameArabic: "يس",
  //      nameComplex: "Yā-Sīn",
  //      nameSimple: "Ya-Sin",
  //      pages: [440, 445],
  //      revelationOrder: 41,
  //      revelationPlace: ChapterRevelationPlace.makkah,
  //      translatedName: {
  //        id: "Yas Sin",
  //        en: "Ya Sin",
  //        ar: "Ya Sin",
  //        tr: "Yâsîn",
  //        fr: "Ya-Sin"
  //      },
  //      versesCount: 83
  //    )
  //  ]
  //  Verses: []