Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 2.82 KB

README.md

File metadata and controls

92 lines (72 loc) · 2.82 KB
Raw

react-quran

Easily add Quran viewer to your react applications!


Installation

# via npm
npm install react-quran

# via yarn
yarn add react-quran

# via pnpm
pnpm add react-quran

Features

  • 📦 High-Quality Text Rendering: Uses the official Hafs font of the Mushaf, avoiding the use of SVGs to ensure high-customizability.
  • 🎨 Customizable Layout: Easily adjust the styles to fit your app needs. This is only intended to be used to implement dark and light mode.
  • 📦 Lightweight and Fast: Designed to have a minimal impact on your application's performance.
  • 📘 TypeScript Support: Fully compatible with TypeScript.

Usage

// Import styles; which imports the font of the quran.
import 'react-quran/fonts/index.css'

// Import the ReadingView component.
import { ReadingView } from 'react-quran'

const App = () => {
    return (
        <div>
            <ReadingView
                page={2}
                readingViewStyles={{
                    width: '512px',
                    maxWidth: '100%',
                    backgroundColor: 'hsl(200 5% 90% / 1)',
                    borderRadius: 8,
                }}
                surahTitleStyles={{
                    color: 'black',
                }}
                fixedAspectRation={true}
            />
        </div>
    )
}

export default App

Contribute

Contributions are welcome! Feel free to submit issues or pull requests.

Thanks

This could not have been achieved without the grace of Allāh, who helped us to do this, and then the valuable resources that help achieve digital solutions for Muslims and Islam. May allah bless them with His mercy. While not all resources used during development are remembered, here are the ones that come to mind.

  • King Fahd Glorious Qur'an Printing Complex for providing the Uthmani font of the Qur'ān and data of the verses and chapters.
  • Quran.com for providing their useful API which is used to get verses of the Qur'ān line-by-line.
  • Tanzil for providing a lot of valudable data such as Qur'ān text

resources

If you have any useful resources that can make this project better, please open an issues and share it!

License

Distributed under the MIT License. See LICENSE for more information.