mirror of
https://github.com/acamarata/dayjs-hijri-plus.git
synced 2026-06-30 18:54:26 +00:00
f9ad1e52ed
toHijri() now passes Date.UTC(year, month, date) to hijri-core instead of the raw instant from this.toDate(). Fixes wrong-Hijri-day results around UTC-midnight on hosts east or west of UTC. Lock-step with hijri-core fix/utc-day-boundary.
53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
# dayjs-hijri-plus
|
|
|
|
[](https://www.npmjs.com/package/dayjs-hijri-plus)
|
|
[](https://github.com/acamarata/dayjs-hijri-plus/actions/workflows/ci.yml)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
A Day.js plugin that adds Hijri calendar support. Converts Gregorian dates to and from Hijri, provides Hijri-aware formatting, and delegates all calendar logic to [hijri-core](https://github.com/acamarata/hijri-core).
|
|
|
|
Supports Umm al-Qura (UAQ) and FCNA/ISNA calendars. Custom engines can be registered at runtime.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
pnpm add dayjs dayjs-hijri-plus hijri-core
|
|
```
|
|
|
|
Both `dayjs` and `hijri-core` are peer dependencies.
|
|
|
|
## Quick Start
|
|
|
|
```ts
|
|
import dayjs from 'dayjs';
|
|
import hijriPlugin from 'dayjs-hijri-plus';
|
|
|
|
dayjs.extend(hijriPlugin);
|
|
|
|
const d = dayjs('2023-03-23');
|
|
d.toHijri(); // { hy: 1444, hm: 9, hd: 1 }
|
|
d.formatHijri('iD iMMMM iYYYY'); // '1 Ramadan 1444'
|
|
d.formatHijri('iYYYY-iMM-iDD'); // '1444-09-01'
|
|
|
|
dayjs.fromHijri(1444, 10, 1).format('YYYY-MM-DD'); // '2023-04-21'
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Full API reference, examples, and architecture notes are on the [GitHub Wiki](https://github.com/acamarata/dayjs-hijri-plus/wiki).
|
|
|
|
## Day boundaries and time zones
|
|
|
|
`.toHijri()` converts the calendar date the dayjs instance displays — the same date you would read off the screen — regardless of the host's system timezone or whether the dayjs `utc` plugin is active. A call like `dayjs('2025-03-01').toHijri()` always maps the 1st of March 2025, not whatever local instant that string resolves to in UTC.
|
|
|
|
Religious start-of-day at sunset is out of scope. Sunset-aware day boundaries require external prayer-time data and are not handled here.
|
|
|
|
## Related
|
|
|
|
- [hijri-core](https://github.com/acamarata/hijri-core): the zero-dependency Hijri calendar engine this plugin wraps
|
|
- [luxon-hijri](https://github.com/acamarata/luxon-hijri): the same conversion for Luxon users
|
|
- [pray-calc](https://github.com/acamarata/pray-calc): Islamic prayer time calculation
|
|
|
|
## License
|
|
|
|
MIT. Copyright (c) 2026 Aric Camarata.
|