headless library
Headless (non-UI) exports — all services with zero Flutter widget dependency.
import 'package:quran_kit/headless.dart';
Classes
- AsbabNuzulEntry
- A single asbab al-nuzul (occasion of revelation) entry.
- CpalModifier
- Modifies the CPAL color table in a TTF/OTF font.
- FontCache
- Manages the local font cache directory.
- FontDownloader
- Downloads QFC4 font bundles from a CDN (GitHub Releases).
- FontLoader
- Loads QFC4 fonts into the Flutter engine and manages page readiness.
- HizbMarker
- A hizb/rub marker with its location.
- JsonFileQuranStorage
- Default file-based storage that uses a single JSON file.
- KhatmaInfo
- Short khatma info record.
- PageRenderer
- Builds render blocks for a Quran page from the QPC v4 data.
- 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
- QuranAsbabNuzulService
- Service for loading asbab al-nuzul (occasions of revelation) data.
- QuranAudioService
- Audio service for playing Quran ayah-by-ayah from everyayah.com.
- QuranAudioState
- Immutable snapshot of audio playback state.
- QuranAutoNightMode
- Auto night mode — switches between light and dark themes based on time.
- QuranDataLoader
- Loads QPC v4 page-layout and word data from bundled gzipped JSON assets.
- QuranEdition
- A Quran translation/edition identifier.
- QuranEmbeddedText
- Provides offline access to embedded Arabic text (Uthmani + Simple).
- QuranMetadata
- Provides metadata about the Quran — surah names, page lookups, bookmarks, juz mapping, sajda positions, hizb/rub markers, qira'at.
- QuranReadingStats
- Reading statistics — aggregates daily logs into weekly/monthly summaries.
- QuranReadingTheme
- A complete color palette for the Quran reading experience.
- QuranReciter
- A Quran reciter (name in Arabic/English + CDN path segments per bitrate).
- QuranSearchEngine
- Smart Arabic-aware Quran search engine.
- QuranSearchFilter
- Search filter options.
- QuranSearchResult
- A single search result.
- QuranSettingsService
- مركز الإعدادات الشامل للقرآن الكريم يدير: الترجمات، التفاسير، القراءات، أحجام الخطوط، الأهداف اليومية
- QuranStorage
- Abstract key-value storage interface used by quran_kit services.
- QuranTafsirService
- Service for downloading and serving tafsir/translation data.
- QuranTextService
- Service for fetching Quran text, translations, and transliterations from the free alquran.cloud API.
- QuranThemes
- Built-in reading themes.
- QuranVoiceSearch
- Voice search coordinator — combines speech recognizer with search engine.
- QuranWirdService
- Daily wird (reading portion) tracker.
- QuranWordService
- Service for word-by-word Quran data and audio.
- SajdaPosition
- A sajda (prostration) position in the Quran.
- SpeechRecognizer
- Abstract speech recognizer that consumers must implement.
- SurahNameInfo
- Surah names model, loaded from surahs_name.json.gz.
- TafsirBook
- A tafsir or translation book.
- TafsirEntry
- A single tafsir entry (one ayah).
- TajweedRule
- Tajweed color rules for QFC4 fonts.
- WordAudioState
- Audio playback state for word audio.
- WordInfo
- Word info model.
Enums
- AudioQuality
- Audio quality levels.
- QpcV4LineType
- Data models for QPC v4 page layout and word data.
- WordDataKind
- The kind of word data to display.
Constants
-
kAvailableTafsirs
→ const List<
TafsirBook> - Available tafsir/translation books (14 total).
-
kHizbMarkers
→ const List<
HizbMarker> - All 240 rub al-hizb markers (60 hizb × 4 quarters each).
- kKhatmaDuaArabic → const String
- Khatma (Quran completion) du'a and related content. Khatma du'a text — the supplication recited upon completing the Quran.
- kKhatmaDuaTransliteration → const String
- Khatma du'a transliteration.
- kKhatmaInfo → const KhatmaInfo
- Access the khatma du'a content.
-
kQiraat
→ const List<
Qiraa> - The 10 canonical qira'at (readings).
-
kQuranEditions
→ const List<
QuranEdition> - 30+ translations from api.alquran.cloud
-
kSajdaPositions
→ const List<
SajdaPosition> - The 15 sajda (prostration) positions per scholarly consensus.
-
tajweedRules
→ const List<
TajweedRule> - The 8 tajweed color rules in QFC4 fonts.