quran library

Constants

basmala → const String
The constant 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ'
sajdah → const String
The constant 'سَجْدَةٌ'
totalJuzCount → const int
The constant total juz count
totalMadaniSurahs → const int
The constant total of madani surahs
totalMakkiSurahs → const int
The constant total of makki surahs
totalPagesCount → const int
The most standard and common copy of Arabic only Quran total pages count
totalSurahCount → const int
The constant total surah count
totalVerseCount → const int
The constant total verse count

Functions

getAudioURLBySurah(int surahNumber) → String
Takes surahNumber and returns audio URL of that surah
getAudioURLByVerse(int surahNumber, int verseNumber) → String
Takes surahNumber & verseNumber and returns audio URL of that verse
getAudioURLByVerseNumber(int verseNumber) → String
Takes verseNumber and returns audio URL of that verse
getJuzNumber(int surahNumber, int verseNumber) → int
Takes surahNumber & verseNumber and returns Juz number
getJuzURL(int juzNumber) → String
Takes juzNumber and returns Juz URL (from Quran.com)
getPageData(int pageNumber) → List
Takes pageNumber and returns a list containing Surahs and the starting and ending Verse numbers in that page
getPageNumber(int surahNumber, int verseNumber) → int
Takes surahNumber, verseNumber and returns the page number of the Quran
getPlaceOfRevelation(int surahNumber) → String
Takes surahNumber and returns the place of revelation (Makkah / Madinah) of the surah
getSurahAndVersesFromJuz(int juzNumber) → Map<int, List<int>>
Takes juzNumber and returns a map which contains keys as surah number and value as a list containing starting and ending verse numbers.
getSurahCountByPage(int pageNumber) → int
Takes pageNumber and returns total surahs count in that page
getSurahName(int surahNumber) → String
Takes surahNumber and returns the Surah name
getSurahNameArabic(int surahNumber) → String
Takes surahNumber returns the Surah name in Arabic
getSurahNameEnglish(int surahNumber) → String
Takes surahNumber returns the Surah name in English
getSurahNameFrench(int surahNumber) → String
Takes surahNumber returns the Surah name in French
getSurahNameTurkish(int surahNumber) → String
Takes surahNumber returns the Surah name in Turkish
getSurahPages(int surahNumber) → List<int>
Takes surahNumber and returns the list of page numbers of the surah
getSurahURL(int surahNumber) → String
Takes surahNumber and returns Surah URL (from Quran.com)
getVerse(int surahNumber, int verseNumber, {bool verseEndSymbol = false}) → String
Takes surahNumber, verseNumber & verseEndSymbol (optional) and returns the Verse in Arabic
getVerseCount(int surahNumber) → int
Takes surahNumber and returns the count of total Verses in the Surah
getVerseCountByPage(int pageNumber) → int
Takes pageNumber and returns total verses count in that page
getVerseEndSymbol(int verseNumber, {bool arabicNumeral = true}) → String
Takes verseNumber, arabicNumeral (optional) and returns '۝' symbol with verse number
getVersesTextByPage(int pageNumber, {bool verseEndSymbol = false, SurahSeperator surahSeperator = SurahSeperator.none, String customSurahSeperator = ""}) → List<String>
Takes pageNumber, verseEndSymbol, surahSeperator & customSurahSeperator and returns the list of verses in that page if customSurahSeperator is given, surahSeperator will not work.
getVerseTranslation(int surahNumber, int verseNumber, {bool verseEndSymbol = false, Translation translation = Translation.enSaheeh}) → String
Takes surahNumber, verseNumber, verseEndSymbol (optional) & translation (optional) and returns verse translation
getVerseURL(int surahNumber, int verseNumber) → String
Takes surahNumber & verseNumber and returns Verse URL (from Quran.com)
isSajdahVerse(int surahNumber, int verseNumber) → bool
Takes surahNumber & verseNumber and returns true if verse is sajdah
searchWords(List<String> words) → Map
Takes a list of words words and returns a map containing no. of occurences and result of the word search in the arabic quran text.
searchWordsInTranslation(List<String> words, {Translation translation = Translation.enSaheeh}) → Map
Takes a list of words words and translation (optional) and returns a map containing no. of occurences and result of the word search in the traslation