jquery-prayer-times
A small jQuery plugin for displaying Muslim Prayer Times.
Features!
- English/Arabic language support.
- Auto detect visitor location. (Limited to 1,000 requests per day).
- Store data in local storage to make one request per user per day.
- 13 Different Calculation Methods.
- 2 Calculation Methods for Asr Time. (Shafei/Hanafi).
- 2 Formats for time. (24-hour/12-hour).
- Ability to show/hide additional times. (imsak, sunrise, sunset and midnight).
Install
$ npm install jquery-prayer-times --save
or
<!-- jquery file -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<!-- jquery.prayer.times file -->
<script src="jquery.prayer.times.min.js"></script>
Examples:
<!-- prayer times will be appended to this div -->
<div class="prayer-times"></div>
1- Default:
$('.prayer-times').prayerTimes();
2- Arabic:
$('.prayer-times').prayerTimes({ arabic: true });
Options:
Prop | Type | Description | Default |
---|---|---|---|
method | number |
A prayer times calculation method. Methods identify various schools of thought about how to compute the timings. Available Methods: 1 - University of Islamic Sciences, Karachi 2 - Islamic Society of North America (ISNA) 3 - Muslim World League 4 - Umm Al-Qura University, Makkah 5 - Egyptian General Authority of Survey 7 - Institute of Geophysics, University of Tehran 8 - Gulf Region 9 - Kuwait 10 - Qatar 11 - Majlis Ugama Islam Singapura, Singapore 12 - Union Organization islamic de France 13 - Diyanet İşleri Başkanlığı, Turkey 14 - Spiritual Administration of Muslims of Russia |
4 |
school | number |
Asr calculation method. Available Methods: 0 - Shafei 1 - Hanafi |
0 |
country | string |
A country name or 2 character alpha ISO 3166 code. (Examples: SA or Saudi Arabia ) If you leave this empty, it defaults to user country. |
null |
city | string |
A city name. (Example: Mecca ) If you leave this empty, it defaults to user city. |
null |
imsak | boolean |
Set to true or false to show or hide the imsak time |
true |
sunrise | boolean |
Set to true or false to show or hide the sunrise time |
true |
sunset | boolean |
Set to true or false to show or hide the sunset time |
true |
midnight | boolean |
Set to true or false to show or hide the midnight time |
true |
arabic | boolean |
Set to true or false to display in arabic |
false |
militaryTime | boolean |
Set to true or false to switch between 24-hour and 12-hour formats |
true |
outputEl |
'table' | 'ul'
|
Determine an HTML element to print timings. | 'table' |
3- Customized:
$('.prayer-times').prayerTimes({
arabic: true,
method: 5,
militaryTime: false,
imsak: false,
sunset: false,
midnight: false
});
License
MIT