mirror of
https://github.com/acamarata/moment-hijri-plus.git
synced 2026-06-30 18:54:29 +00:00
Fix documentation style (no em dashes). Update hijri-core devDep from file: path to ^1.0.0. Add wiki-sync workflow permissions. Correct UAQ range to 1318-1500 AH / 1900-2076 CE throughout.
1.4 KiB
1.4 KiB
moment-hijri-plus
A Moment.js plugin for Hijri calendar conversion and formatting. All calendar arithmetic is handled by hijri-core, keeping this package thin and focused.
What it does
- Converts any moment to a Hijri date object (
{ hy, hm, hd }) - Formats moments using Hijri-specific tokens mixed freely with standard Moment format tokens
- Constructs moments from Hijri dates via
moment.fromHijri() - Supports Umm al-Qura (UAQ) and FCNA/ISNA calendars
Pages
- API Reference: complete method signatures and examples
- Architecture: design rationale, token system, calendar delegation
Quick start
pnpm add moment moment-hijri-plus hijri-core
import moment from 'moment';
import installHijri from 'moment-hijri-plus';
installHijri(moment);
moment(new Date(2023, 2, 23)).toHijri();
// => { hy: 1444, hm: 9, hd: 1 } (1 Ramadan 1444 AH)
moment(new Date(2023, 2, 23)).formatHijri('iD iMMMM iYYYY AH');
// => '1 Ramadan 1444 AH'
moment.fromHijri(1446, 1, 1).format('YYYY-MM-DD');
// => '2024-07-07'
Related packages
- hijri-core: the calendar engine
- luxon-hijri: same support for Luxon
- pray-calc: Islamic prayer time calculation