core library
Core data layer — pure Dart, no Flutter dependency.
Provides Quran metadata (114 surahs, 604 pages, 30 juz, 60 hizb, 240 rub, 15 sajda, 10 qira'at), bookmarks, data loading, and themes.
Classes
- HizbMarker
- A hizb/rub marker with its location.
- JsonFileQuranStorage
- Default file-based storage that uses a single JSON file.
- Qiraa
- A Quran reading (qira'a) with its narrator (rawi).
- QpcV4AssetsStore
- Holds the loaded page layout and word data.
- QpcV4AyahInfoLine
- QpcV4AyahLineBlock
- QpcV4BasmallahBlock
- QpcV4RenderBlock
- QpcV4SurahHeaderBlock
- QpcV4Word
- QpcV4WordSegment
- QuranDataLoader
- Loads QPC v4 page-layout and word data from bundled gzipped JSON assets.
- QuranMetadata
- Provides metadata about the Quran — surah names, page lookups, bookmarks, juz mapping, sajda positions, hizb/rub markers, qira'at.
- QuranReadingTheme
- A complete color palette for the Quran reading experience.
- QuranStorage
- Abstract key-value storage interface used by quran_kit services.
- QuranThemes
- Built-in reading themes.
- SajdaPosition
- A sajda (prostration) position in the Quran.
- SurahNameInfo
- Surah names model, loaded from surahs_name.json.gz.
Enums
- QpcV4LineType
- Data models for QPC v4 page layout and word data.
Constants
-
kHizbMarkers
→ const List<
HizbMarker> - All 240 rub al-hizb markers (60 hizb × 4 quarters each).
-
kQiraat
→ const List<
Qiraa> - The 10 canonical qira'at (readings).
-
kSajdaPositions
→ const List<
SajdaPosition> - The 15 sajda (prostration) positions per scholarly consensus.