FlutterQuran class

Constructors

FlutterQuran()
factory

Properties

hafsStyle → TextStyle
hafsStyle is the default style for Quran so all special characters will be rendered correctly
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getAllBookmarks() → List<Bookmark>
getAllBookmarks returns list of all bookmarks
getAllHizbs() → List<String>
getAllHizbs returns list of all Quran hizbs' names
getAllJozzs() → List<String>
getAllJozzs returns list of all Quran jozzs' names
getAllSurahs({bool isArabic = true}) → List<String>
getAllSurahs returns list of all Quran surahs' names
getCurrentPageNumber() → int
getCurrentPageNumber Returns the page number of the page that the user is currently on. Page numbers start at 1, so the first page of the Quran is page 1.
getSurah(int surah) → Surah
getSurah let's you get a Surah with all its data Note it receives surah number not surah index
getUsedBookmarks() → List<Bookmark>
getUsedBookmarks returns list of all bookmarks used and set by the user in quran pages
init({List<Bookmark>? userBookmarks, bool overwriteBookmarks = false}) → Future<void>
init initializes the FlutterQuran, and must be called before starting using the package
navigateToAyah let's you navigate to any ayah.. It's better to call this method while Quran screen is displayed and if it's called and the Quran screen is not displayed, the next time you open quran screen it will start from this ayah's page
navigateToBookmark let's you navigate to a certain bookmark Note that bookmark page number must be between 1 and 604
navigateToHizb let's you navigate to any quran hizb with hizb number Note it receives hizb number not hizb index
navigateToJozz let's you navigate to any quran jozz with jozz number Note it receives jozz number not jozz index
navigateToPage let's you navigate to any quran page with page number Note it receives page number not page index It's better to call this method while Quran screen is displayed and if it's called and the Quran screen is not displayed, the next time you open quran screen it will start from this page
navigateToSurah let's you navigate to any quran surah with surah number Note it receives surah number not surah index
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeBookmark({required int bookmarkId}) → void
Removes a bookmark from the list of user's saved bookmarks. bookmarkId is the id of the bookmark to be removed.
search Searches the Quran for the given text.
setBookmark({required int ayahId, required int page, required int bookmarkId}) → void
Sets a bookmark with the given ayahId, page and bookmarkId.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited