# jquery-prayer-times

> A small jQuery plugin for displaying Muslim Prayer Times

Latest version **1.0.8** (published 2021-02-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install jquery-prayer-times
pnpm add jquery-prayer-times
yarn add jquery-prayer-times
bun add jquery-prayer-times
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2021-02-26 |
| First published | 2021-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Muhammad Mabrouk |
| Maintainers | muhammad_mabrouk |
| Keywords | prayer-times, prayer, times, muslim, islam, jquery |

## Links

- npm: https://www.npmjs.com/package/jquery-prayer-times
- Repository: https://github.com/MuhammadMabrouk/jquery-prayer-times
- Homepage: https://github.com/MuhammadMabrouk/jquery-prayer-times#readme
- Issues: https://github.com/MuhammadMabrouk/jquery-prayer-times/issues
- npm.io page: https://npm.io/package/jquery-prayer-times

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2021-02-26
- 1.0.7 — 2021-02-16
- 1.0.6 — 2021-02-15
- 1.0.5 — 2021-02-15
- 1.0.4 — 2021-02-15
- 1.0.3 — 2021-02-15
- 1.0.2 — 2021-02-15
- 1.0.1 — 2021-02-15
- 1.0.0 — 2021-02-14

## README

# jquery-prayer-times

A small jQuery plugin for displaying Muslim Prayer Times.

<br>

### 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)*.


<br>

### Install

```sh
$ npm install jquery-prayer-times --save
```

or

```html
<!-- 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>
```


<br>

### Examples:

```html
<!-- prayer times will be appended to this div -->
<div class="prayer-times"></div>
```


<br>

**1- Default:**
```javascript
$('.prayer-times').prayerTimes();
```

<br>

![alt text](https://drive.google.com/uc?export=view&id=1BrO_Y1spw7LDD5QT9wfPR6JuPUHuDPmh "Default Prayer Times")


<br>

**2- Arabic:**
```javascript
$('.prayer-times').prayerTimes({ arabic: true });
```

<br>

![alt text](https://drive.google.com/uc?export=view&id=1yn5_djV6dG73rw-f2W2IB1aTKIhXWVP7 "Arabic")

<br>

### Options:
| Prop | Type | Description | Default |
| ----------- |    :----:   | ----------- |    :----:   |
| method | `number` | A prayer times calculation method. <br> Methods identify various schools of thought about how to compute the timings. <br> Available Methods: <br> `1` - University of Islamic Sciences, Karachi <br> `2` - Islamic Society of North America (ISNA) <br> `3` - Muslim World League <br> `4` - Umm Al-Qura University, Makkah <br> `5` - Egyptian General Authority of Survey <br> `7` - Institute of Geophysics, University of Tehran <br> `8` - Gulf Region <br> `9` - Kuwait <br> `10` - Qatar <br> `11` - Majlis Ugama Islam Singapura, Singapore <br> `12` - Union Organization islamic de France <br> `13` - Diyanet İşleri Başkanlığı, Turkey <br> `14` - Spiritual Administration of Muslims of Russia | `4` |
| school | `number` | Asr calculation method. Available Methods: <br> `0` - Shafei <br> `1` - Hanafi | `0` |
| country | `string` | A country name or 2 character alpha ISO 3166 code. <br> (Examples: `SA` or `Saudi Arabia`) <br> If you leave this empty, it defaults to user country. | `null` |
| city | `string` | A city name. (Example: `Mecca`) <br> 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'` &#124; `'ul'` | Determine an HTML element to print timings. | `'table'` |

<br>

**3- Customized:**
```javascript
$('.prayer-times').prayerTimes({
  arabic: true,
  method: 5,
  militaryTime: false,
  imsak: false,
  sunset: false,
  midnight: false
});
```

<br>

![alt text](https://drive.google.com/uc?export=view&id=1PODfTdS4E3y2Pn8laqSF__cD8B3dqPjy "Customized")

<br><br>

### License

MIT

---
_Source: https://npm.io/package/jquery-prayer-times · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._