quran_flutter

Description:

quran flutter

Quran Flutter #
quran_flutter is a Flutter package designed to provide access to the text of the Quran in multiple languages, sourced from Tanzil.net. Metadata about Surahs (chapters), Verses, and Juzs (sections) is also provided.
Screenshots #







Table of Contents #

Quran Flutter

Screenshots
Table of Contents
Getting started
Installation
Initialization
Constants
Available Quran Translations
Quran Text
Surah Methods
Verse Methods
Juz Methods
Example
Contributing

Bug Reports
Feature Requests
Pull Requests
Conclusion


License



Getting started #
Installation #
Add the following to your pubspec.yaml file:
dependencies:
flutter:
sdk: flutter
quran_flutter: ^1.0.0
copied to clipboard
Initialization #
import 'package:flutter/material.dart';
import 'package:quran_flutter/quran_flutter.dart';

Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
await Quran.initialize();
runApp(const MyApp());
}
copied to clipboard
Constants #

bismillah - The Bismillah phrase: بِسْمِ اللَّهِ الرَّحْمَـٰنِ الرَّحِيمِ
surahCount - Total number of surahs in the Quran.
makkiSurahCount - Total number of Makki surahs in the Quran.
madaniSurahCount - Total number of Madani surahs in the Quran.
verseCount - Total number of verses in the Quran.
juzCount - Total number of juz in the Quran.

Available Quran Translations #

Albanian
Amazigh
Amharic
Azerbaijani
Bengali
Bosnian
Bulgarian
Chinese
Czech
Divehi
Dutch
English
French
German
Hausa
Hindi
Indonesian
Italian
Japanese
Korean
Kurdish
Malay
Malayalam
Norwegian
Pashto
Persian
Polish
Portuguese
Romanian
Russian
Sindhi
Somali
Spanish
Swahili
Swedish
Tajik
Tamil
Tatar
Thai
Turkish
Urdu
Uyghur
Uzbek

Quran Text #
The Quran text can be accessed in different languages using the provided function.
getQuranVerses:
This function retrieves the Quran text based on the specified language.
Usage:
// Get Quran text in Arabic
Map<int, Map<int, Verse>> quranVerses = Quran.getQuranVerses();

// Get Quran text in English
Map<int, Map<int, Verse>> quranVersesEnglish = Quran.getQuranVerses(language: QuranLanguage.english);
copied to clipboard
Parameters:

language (optional) - The language in which you want to retrieve the Quran text. It can be any supported language from the QuranLanguage enum, or null for the original Arabic text.

Returns:
A map where the key is the surah number and the value is another map with the verse number as the key and the Verse object as the value.
Surah Methods #


Map<int, Surah> getSurahAsMap() - Returns a map containing all the surahs indexed by their numbers.


List<Surah> getSurahAsList() - Returns a list of all surahs in the Quran.


Surah getSurah(int surahNumber) - Returns the Surah object for the specified surah number.


Map<int, Verse> getSurahVersesAsMap(int surahNumber, {QuranLanguage? language}) - Returns the verses of the specified surah as a map indexed by verse numbers, optionally in the specified language.


List<Verse> getSurahVersesAsList(int surahNumber, {QuranLanguage? language}) - Returns the verses of the specified surah as a list, optionally in the specified language.


String getSurahName(int surahNumber) - Returns the name of the specified surah.


String getSurahNameEnglish(int surahNumber) - Returns the English name of the specified surah.


int getTotalVersesInSurah(int surahNumber) - Returns the total number of verses in the specified surah.


int getRevealationOrderInSurah(int surahNumber) - Returns the revelation order of the specified surah.


int getRukusInSurah(int surahNumber) - Returns the number of rukus in the specified surah.


SurahType getSurahType(int surahNumber) - Returns the type (Meccan or Medinan) of the specified surah.


bool isMakkiSurah(int surahNumber) - Returns true if the specified surah is Meccan, otherwise false.


bool isMadaniSurah(int surahNumber) - Returns true if the specified surah is Medinan, otherwise false.


Usage:
Map<int, Surah> surahMap = Quran.getSurahAsMap();

List<Surah> surahList = Quran.getSurahAsList();

Surah surah = Quran.getSurah(5);
print(surah.name);
print(surah.nameEnglish);
print(surah.meaning);
print(surah.revealationOrder);

Map<int, Verse> surahVersesMap = Quran.getSurahVersesAsMap(2);

Map<int, Verse> surahVersesMap2 = Quran.getSurahVersesAsMap(4, language: QuranLanguage.english);

List<Verse> surahVersesList = Quran.getSurahVersesAsList(2);

List<Verse> surahVersesList2 = Quran.getSurahVersesAsList(4, language: QuranLanguage.english);

String surahName = Quran.getSurahName(14);
print(surahName);

String surahNameEnglish = Quran.getSurahNameEnglish(14);
print(surahNameEnglish);

int totalVerses = Quran.getTotalVersesInSurah(9);
print(totalVerses);

SurahType surahType = Quran.getSurahType(21);
print(surahType.value);

bool isMadaniSurah = Quran.isMadaniSurah(45);
print(isMadaniSurah);
copied to clipboard
Verse Methods #

Verse getVerse({required int surahNumber, required int verseNumber, QuranLanguage? language}) - Retrieves the verse corresponding to the given surah number and verse number. Optionally, you can specify the language in which to retrieve the verse.

Usage:
Verse verse = Quran.getVerse(surahNumber: 1, verseNumber: 5);
print(verse.text);

Verse verseEnglish = Quran.getVerse(surahNumber: 1, verseNumber: 5, language: QuranLanguage.english);
print(verseEnglish.text);
copied to clipboard
Juz Methods #


Map<int, Juz> getJuzAsMap() - Retrieves a map of all juz with their corresponding numbers.


List<Juz> getJuzAsList() - Retrieves a list of all juz.


int getTotalVersesInJuz(int juzNumber) - Retrieves the total number of verses in the specified juz.


Map<int, JuzSurahVerses> getSurahVersesInJuzAsMap(int juzNumber) - Retrieves the verses of each surah within the specified juz as a map.


List<JuzSurahVerses> getSurahVersesInJuzAsList(int juzNumber) - Retrieves the verses of each surah within the specified juz as a list.


int getTotalVersesOfSurahInJuz({required int surahNumber, required int juzNumber}) - Retrieves the total number of verses of the specified surah within the specified juz.


int getJuzNumber({required int surahNumber, required int verseNumber}) - Retrieves the juz number of the specified surah and verse.


Usage:
Map<int, Juz> juzMap = Quran.getJuzAsMap();

List<Juz> juzList = Quran.getJuzAsList();

int totalVersesInJuz = Quran.getTotalVersesInJuz(15);
print(totalVersesInJuz);

Map<int, JuzSurahVerses> juzSurahVersesMap = Quran.getSurahVersesInJuzAsMap(23);

List<JuzSurahVerses> juzSurahVersesList = Quran.getSurahVersesInJuzAsList(23);

int totalVersesOfSurahInJuz = Quran.getTotalVersesOfSurahInJuz(surahNumber: 1, juzNumber: 1);
print(totalVersesOfSurahInJuz);

int juzNumber = Quran.getJuzNumber(surahNumber: 2, verseNumber: 11);
print(juzNumber);
copied to clipboard
Example #
You can find an example app demonstrating the usage of the quran_flutter package in the example directory.
To run the example app:

Clone this repository.
Navigate to the example directory.
Run flutter pub get to install dependencies.
Run flutter run to launch the example app on an emulator or a physical device.

Contributing #
Thank you for considering contributing to Quran Flutter! Contributions from users like you help improve the project and make it better for everyone.
Bug Reports #
If you encounter a bug while using Quran Flutter, please open an issue on GitHub. Be sure to include detailed information about how to reproduce the bug, including steps to replicate it, the expected behavior, and the actual behavior you observed. Screenshots or code examples can also be helpful.
Feature Requests #
If you have an idea for a new feature or enhancement, feel free to open an issue on GitHub to discuss it. We welcome suggestions for improvements and additions to Quran Flutter.
Pull Requests #
If you'd like to contribute directly to the project, you can submit a pull request with your changes. Here's how:

Fork the repository by clicking the Fork button on GitHub.
Clone your fork of the repository to your local machine.
Create a new branch for your changes: git checkout -b my-feature
Make your changes in the new branch.
Test your changes to ensure they work as expected.
Commit your changes with descriptive commit messages: git commit -m "Add new feature".
Push your branch to your fork on GitHub: git push origin my-feature.
Submit a pull request from your branch to the main branch of the original repository.

Your pull request will be reviewed by the project maintainers, and feedback may be provided to help improve your contribution.
Conclusion #
Thank you for considering contributing to quran_flutter. Your contributions are valued and help improve the project for everyone. Happy coding!
License #
MIT License
Copyright (c) 2024 Waqar Ali Siyal
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.