QuranKitConfig class

Configuration for QuranKit.initialize.

All fields have sensible defaults — only override what you need.

final config = QuranKitConfig(
  fontBaseUrl: 'https://cdn.example.com/qfc4_fonts',
  enableAudio: true,
  defaultTheme: QuranThemes.parchment,
);
await QuranKit.initialize(config);

Constructors

QuranKitConfig({String fontBaseUrl = '', QuranStorage? storage, bool enableAudio = true, bool enableTafsir = true, bool enableSearch = true, bool enableWordByWord = true, bool enableAsbabNuzul = true, int defaultReciterIndex = 0, String defaultTafsirId = 'al-tabari', String defaultEditionId = 'ar-uthmani', String defaultQiraa = 'hafs', QuranReadingTheme? defaultTheme, int readingGoal = 20, bool showTajweed = true, bool enableAutoNightMode = false, int nightStartHour = 18, int nightEndHour = 6})
const

Properties

defaultEditionId → String
Default text edition identifier (e.g. 'ar-uthmani').
final
defaultQiraa → String
Default qiraa variant (e.g. 'hafs').
final
defaultReciterIndex → int
Default reciter index (0-based, from QuranAudioService.reciters).
final
defaultTafsirId → String
Default tafsir identifier (e.g. 'al-tabari').
final
defaultTheme → QuranReadingTheme?
Default reading theme.
final
enableAsbabNuzul → bool
Enable asbab al-nuzul (occasions of revelation) service.
final
enableAudio → bool
Enable audio playback service.
final
enableAutoNightMode → bool
Enable auto night mode at startup.
final
enableSearch → bool
Enable full-text search service.
final
enableTafsir → bool
Enable tafsir (exegesis) service.
final
enableWordByWord → bool
Enable word-by-word data service.
final
fontBaseUrl → String
CDN base URL for QPC v4 font bundles (required for rendering).
final
hashCode → int
The hash code for this object.
no setterinherited
nightEndHour → int
Night mode end hour (24h format). Default 6 (6 AM).
final
nightStartHour → int
Night mode start hour (24h format). Default 18 (6 PM).
final
readingGoal → int
Daily reading goal in pages.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showTajweed → bool
Whether to show tajweed coloring by default.
final
storage → QuranStorage?
Custom storage backend. Defaults to JsonFileQuranStorage.
final

Methods

copyWith({String? fontBaseUrl, QuranStorage? storage, bool? enableAudio, bool? enableTafsir, bool? enableSearch, bool? enableWordByWord, bool? enableAsbabNuzul, int? defaultReciterIndex, String? defaultTafsirId, String? defaultEditionId, String? defaultQiraa, QuranReadingTheme? defaultTheme, int? readingGoal, bool? showTajweed, bool? enableAutoNightMode, int? nightStartHour, int? nightEndHour}) → QuranKitConfig
Creates a copy with overridden fields.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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