Choosing a block
Eight packages, each answering a different question. The fastest way to choose is to start from what you are trying to put on a screen, not from the package names.
Start from your task
| You want to… | Use |
|---|---|
| Show Qur’an text you control the layout of | Quran Text |
| Show the printed page exactly as it appears in a muṣḥaf | Quran SVG |
| Make individual words tappable | Quran SVG Elements |
| Do that on mobile, at speed | Quran Engine |
| Colour the text by recitation rule | Quran Tajweed |
| Support more than one reading, or translate a reference | Qiraat Ayah Map |
| Draw ayah markers, frames or surah headers | Quran Assets |
| Share an ayah as an image | Quran PNG |
The relationship that is easiest to get wrong
Quran SVG, Quran SVG Elements and Quran Engine are not three stages of one pipeline, and not a queue where the others eventually catch up. They trade coverage against how deeply you can address the page.
| Coverage | You can address | |
|---|---|---|
| Quran SVG | Every vectorised muṣḥaf, and growing by contribution | An ayah |
| Quran SVG Elements | Only what has been split | A word, a mark — a letter, later |
| Quran Engine | Those split muṣḥafs, on mobile | The same, fast |
Quran SVG is the archive, not a stepping stone. Splitting a muṣḥaf is hard, and not every one of them will ever be split.
Quran Engine exists because SVG does not perform on mobile. That is the reason to reach for it, not a benchmark.
Elements ships 604 whole displayable pages too. The difference is what you can address, never “pages versus parts”.
All eight, by role
Data
Pages & Assets
Rendering
Annotations
Guidance
What each one is not for
Each entry links to the sibling that does the job instead.
- Printed page layout. Use Quran SVG
- Tajweed colouring. Add Quran Tajweed
- Cross-riwayah ayah mapping. Add Qiraat Ayah Map
- The text itself. Use Quran Text
- Page geometry. Use Quran SVG
- Word-level interaction — these pages carry an ayah layer only. Where a mushaf has been split, use Quran SVG Elements
- Mobile and native, where SVG stops performing. Use Quran Engine
- Text you can search. Use Quran Text
- Any mushaf that has not been split — splitting is hard, and not every mushaf will be. Use Quran SVG
- Mobile and native, where SVG stops performing. Use Quran Engine
- Tapping whole ayat, where an ayah polygon is simpler. Use Quran SVG
- The Quranic text. Use Quran Text
- Complete printed pages. Use Quran SVG
- The web, where the split SVGs already work well. Use Quran SVG Elements
- Just showing a page and tapping ayat — an SVG and a few lines of JavaScript do that. Use Quran SVG
- The text to annotate. Use Quran Text
- Colouring printed artwork. Add Quran SVG Elements
- Runtime behaviour — it ships no code into your app.
- Verified text. That is Quran Text