quran 1.1.2 quran: ^1.1.2 copied to clipboard
Full Quran text (Arabic) & details including pages, juz, surah, verses and place of revelation etc.
Full Quran text (Arabic) & details including pages, juz, surah, verses and place of revelation etc.
Getting Started #
To use this plugin, add quran
as a dependency in your pubspec.yaml file.
Constants:
totalPagesCount
- The most standard and common copy of Arabic only Quran total pages counttotalMakkiSurahs
- The constant total of makki surahstotalMadaniSurahs
- The constant total of madani surahstotalJuzCount
- The constant total juz counttotalSurahCount
- The constant total surah counttotalVerseCount
- The constant total verse countbasmala
- The constant 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ'
Functions:
-
getJuzNumber(int surahNumber, int verseNumber)
- Takes [surahNumber] & [verseNumber] and returns Juz number -
getSurahAndVersesFromJuz(int juzNumber)
- Takes [juzNumber] and returns a map containing Surah and Verse numbers -
getSurahName(int surahNumber)
- Takes [surahNumber] and returns the Surah name -
getSurahNameEnglish(int surahNumber)
- Takes [surahNumber] returns the Surah name in English -
getSurahNameArabic(int surahNumber)
- Takes [surahNumber] returns the Surah name in Arabic -
getPlaceOfRevelation(int surahNumber)
- Takes [surahNumber] and returns the Place of Revelation (Makkah / Madinah) of that Surah -
getVerseCount(int surahNumber)
- Takes [surahNumber] and returns the count of total Verses in that Surah -
getVerse(int surahNumber, int verseNumber, {bool verseEndSymbol})
- Takes [surahNumber], [verseNumber] & [verseEndSymbol] (optional) and returns the Verse in Arabic -
getVerseEndSymbol(int verseNumber)
- Takes [verseNumber] and returns '' symbol with verse number -
getJuzURL(int juzNumber)
- Takes [juzNumber] and returns Juz URL (from Quran.com) -
getSurahURL(int surahNumber)
- Takes [surahNumber] and returns Surah URL (from Quran.com) -
getVerseURL(int surahNumber, int verseNumber)
- Takes [surahNumber] & [verseNumber] and returns Verse URL (from Quran.com) -
getPageData(int pageNumber)
- Takes [pageNumber] and returns a list containing Surahs and the starting and ending Verse numbers in that page -
getSurahCountByPage(int pageNumber)
- Takes [pageNumber] and returns total surahs count in that page -
getVerseCountByPage(int pageNumber)
- Takes [pageNumber] and returns total verses count in that page -
getSurahPages(int surahNumber)
- Takes [surahNumber] and returns the list of page numbers of that surah -
getVersesTextByPage(int pageNumber, {bool verseEndSymbol, SurahSeperator surahSeperator, customSurahSeperator})
- Takes [pageNumber], [verseEndSymbol], [surahSeperator] & [customSurahSeperator] and returns the list of verses in that page
Example #
import 'package:flutter/material.dart';
import 'package:quran/quran.dart' as quran;
void main() {
runApp(MaterialApp(
home: Scaffold(
appBar: AppBar(
title: Text("Quran Demo"),
),
body: SafeArea(
child: Padding(
padding: EdgeInsets.all(15.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text("Juz Number: \n" + quran.getJuzNumber(18, 1).toString()),
Text("\nJuz URL: \n" + quran.getJuzURL(15)),
Text("\nSurah and Verses in Juz 15: \n" + quran.getSurahAndVersesFromJuz(15).toString()),
Text("\nSurah Name: \n" + quran.getSurahName(18)),
Text("\nSurah Name (English): \n" + quran.getSurahNameEnglish(18)),
Text("\nSurah URL: \n" + quran.getSurahURL(18)),
Text("\nTotal Verses: \n" + quran.getVerseCount(18).toString()),
Text("\nPlace of Revelation: \n" + quran.getPlaceOfRevelation(18)),
Text("\nBasmala: \n" + quran.getBasmala()),
Text("\nVerse 1: \n" + quran.getVerse(18, 1))
],
),
),
),
),
));
}
import 'package:flutter/material.dart';
import 'package:quran/quran.dart' as quran;
void main() {
runApp(
MaterialApp(
home: Scaffold(
appBar: AppBar(
title: Text(quran.getSurahName(18)),
),
body: SafeArea(
child: Padding(
padding: EdgeInsets.all(15.0),
child: ListView.builder(
itemCount: quran.getVerseCount(18),
itemBuilder: (context, index) {
return ListTile(
title: Text(
quran.getVerse(18, index + 1, verseEndSymbol: true),
textAlign: TextAlign.right,
),
);
},
),
),
),
),
),
);
}