Skip to main content
Qirtaas is an embeddable editor for Islamic content. Drop one component into your app and your users get a rich-text editor that can insert Quran verses, hadith, and matn (reference) quotes, with full Arabic RTL support — plus a read-only renderer for displaying saved documents. The SDK is framework-agnostic. Use it from vanilla JS, or with the thin @qirtaas/react and @qirtaas/vue wrappers.

​
Two editions, one editor

The editor component is identical everywhere. The only choice you make is which backend powers the content and stores documents:
  • Self-host (Free, MIT) — run the content backend yourself, or point the SDK at your own implementation of the /v1 contract.
  • Managed Cloud — we host the content backend, Quran/hadith data, and image storage. You get an API key and ship.
See Self-host vs Cloud for the full comparison.

​
How it fits together

1

Install the SDK

Add @qirtaas/core to your frontend.
2

Mint embed tokens on your backend

Your server exchanges a secret API key for a short-lived embed token — see Authentication. The secret never touches the browser.
3

Mount the editor / renderer

Create a client with createQirtaasClient and call mountEditor or mountRenderer.

​
Next steps

Quickstart

Install to mounted in 60 seconds.

Client API

Configure the connection once with createQirtaasClient.

Editor

Mount the editor and handle content, autosave and events.

Authentication

Server-side token exchange for embed access.