quran_kit_pro_core 0.1.0
quran_kit_pro_core: ^0.1.0 copied to clipboard
Headless Quran toolkit for Flutter — all services with zero UI widgets. Audio playback, tafsir, word-by-word, search, reading tracker, font pipeline, embedded Arabic text, and more. Use with quran_kit [...]
quran_kit_pro_core #
Headless Quran toolkit for Flutter — all services with zero UI widgets.
For ready-made widgets and screens, use quran_kit_pro_ui.
Architecture #
┌──────────────────────────────────────────┐
│ quran_kit_pro_ui │ ← Widgets + Screens
│ (depends on quran_kit_pro_core) │
├──────────────────────────────────────────┤
│ quran_kit_pro_core │ ← THIS PACKAGE
│ Services │ Models │ Data │ Kit │
└──────────────────────────────────────────┘
Quick Start #
dependencies:
quran_kit_pro_core: ^0.1.0
import 'package:quran_kit_pro_core/kit.dart';
await QuranKit.initialize(QuranKitConfig());
// Use any service directly
final metadata = QuranMetadata.instance;
final surah = metadata.surahByNumber(1);
final audio = QuranAudioService.instance;
await audio.playSurahFrom(1, 1);
Modular Imports #
| Import | Contents |
|---|---|
core.dart |
Metadata, models, storage |
rendering.dart |
Font pipeline (QCF4) |
audio.dart |
Audio playback service |
tafsir.dart |
14 tafsir books |
text.dart |
35+ translation editions |
search.dart |
Arabic search engine |
word.dart |
Word-by-word service |
content.dart |
Asbab al-nuzul, khatma du'a |
reading.dart |
Reading tracker + settings |
theme.dart |
Auto night mode |
kit.dart |
Config + initialize + controller |
headless.dart |
All services combined |
When to use core vs ui #
| Scenario | Package |
|---|---|
| Build custom UI from scratch | quran_kit_pro_core |
| Need only data/services (no widgets) | quran_kit_pro_core |
| Want ready-made widgets + screens | quran_kit_pro_ui |
| Need everything | quran_kit_pro_ui (re-exports core) |
License #
MIT — see LICENSE.