Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamedashraf701/quran_sharif
This Flutter package provides a comprehensive collection of the Quran in both English and Arabic translations.
https://github.com/mohamedashraf701/quran_sharif
Last synced: 13 days ago
JSON representation
This Flutter package provides a comprehensive collection of the Quran in both English and Arabic translations.
- Host: GitHub
- URL: https://github.com/mohamedashraf701/quran_sharif
- Owner: MohamedAshraf701
- License: mit
- Created: 2023-07-05T11:16:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-05T11:44:38.000Z (over 1 year ago)
- Last Synced: 2024-10-22T07:39:07.737Z (2 months ago)
- Language: Dart
- Size: 1.08 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Quran Sharif
[](https://pub.dev/packages/quran_sharif)
A Flutter package that provides utility functions to retrieve information from the Quran, such as surahs, ayahs, and other related data.
## Features
- Complete text of the Quran in English and Arabic
- Support for switching between different translations
- Beautifully formatted display with adjustable font sizes
- Retrieve all surahs from the Quran.
- Get a specific surah by ID.
- Retrieve a list of surah names.
- Filter surahs by revelation type.
- Fetch ayahs by Juz ID.
## Installation
Add the following line to your `pubspec.yaml` file:
```yaml
dependencies:
quran_sharif:
```
Then run `flutter pub get` to fetch the package.
## Usage
Import the package into your Dart file:
```dart
import 'package:quran_sharif/quran_sharif.dart';
```
Use the provided methods to access the Quran data:
```dart
// Retrieve all surahs
List allSurahs = Quran.getAllSurah();
// Get surah by ID
Surahs? surah = Quran.getSurahById(id: 1);
// Get a list of surah names
List surahNames = Quran.getSurahName();
// Filter surahs by revelation type
List makkiSurahs = Quran.getSurahByRevelationType(isMakki: true);
// Get ayahs by Juz ID
List juzAyahs = Quran.getJuz(id: 1);
```
For more details on each method and its usage, refer to the API documentation.
## Examples
You can find more usage examples in the [example](https://github.com/MohamedAshraf701/quran_sharif/tree/main/example) folder of this repository.
## API Documentation
The API documentation for this package can be found [Api Documentation](https://pub.dev/documentation/quran_sharif/latest/quran_sharif/Quran-class.html).
## License
This project is licensed under the [MIT License](https://zaid.digital).
## Contributing
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
## Author
This package is authored and maintained by [zaid.digital](https://zaid.digital).
## Get in touch
If you have any questions, feel free to reach out:
- Email: [email protected]
- Githube: [@MohamedAshraf701](https://github.com/MohamedAshraf701)