Nodding Previously Managed

    moment-hijri
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/moment-hijri package

    2.1.2 • Public • Published

    NPM version MIT License Build Status

    moment-hijri

    A Hijri (Based on Umm al-Qura calculations) calendar system plugin for moment.js.

    About

    Hijri is the Islamic lunar calendar used by Muslims to determine the proper days on which to observe the annual fasting, to attend Hajj, and to celebrate other Islamic holidays and festivals. More information about Hijri can be found at wikipedia.

    This plugin adds Hijri calendar support to momentjs library.

    Calendar conversion is based on the Umm al-Qura calculations.

    Upgrading to 2.0.0

    Because of Using 'h' specifier might cause overlap with hour's specifier, the specifier has been changed from h to i as a prefix. For example in the previous version to get the four digit year, hYYYY will be used. In version 2.0 or above it should be replaced by iYYYY.

    Where to use it?

    Like momentjs, moment-hijri works in browser and in Node.js.

    Node.js

    npm install moment-hijri
    var moment = require('moment-hijri');
    moment().format('iYYYY/iM/iD');

    Browser

    <script src="moment.js"></script>
    <script src="moment-hijri.js"></script>
    <script>
        moment().format('iYYYY/iM/iD');
    </script> 

    Require.js

    require.config({
      paths: {
        "moment": "path/to/moment",
        "moment-hijri": "path/to/moment-hijri"
      }
    });
    define(["moment-hijri"], function (moment) {
      moment().format('iYYYY/iM/iD');
    });

    API

    This plugin tries to mimic momentjs api. Basically, when formatting or parsing a string, add an i to the format token such as 'iYYYY' or 'iM'. For example:

    = moment('1410/8/28', 'iYYYY/iM/iD'); // Parse a Hijri date.
    m.format('iYYYY/iM/iD [is] YYYY/M/D'); // 1410/8/28 is 1990/3/25
     
    m.iYear(); // 1410
    m.iMonth(); // 7
    m.iDate(); // 28
    m.iDayOfYear(); // 236
    m.iWeek(); // 35
    m.iWeekYear(); // 1410
     
    m.add(1, 'iYear');
    m.add(2, 'iMonth');
    m.format('iYYYY/iM/iD'); // 1411/10/28
     
    m.iMonth(11);
    m.startOf('iMonth');
    m.format('iYYYY/iM/iD'); // 1411/12/1
     
    m.iYear(1392);
    m.startOf('iYear');
    m.format('iYYYY/iM/iD'); // 1420/1/1
     
    moment('1436/1/30', 'iYYYY/iMM/iDD').isValid(); // false (This month is only 29 days).
    moment('1436/2/30', 'iYYYY/iMM/iDD').isValid(); // true (This month is 30 days).
     
    moment('1436/2/6 16:40', 'iYYYY/iM/iD HH:mm').format('YYYY-M-D HH:mm:ss'); // 2014-11-28 16:40:00
     
    moment('2014-11-28 16:40:00', 'YYYY-M-D HH:mm:ss').endOf('iMonth').format('iYYYY/iM/iD HH:mm:ss'); // 1436/2/30 23:59:59
     
    // Complex parse:
    moment('1990 5 25', 'YYYY iM D').format('YYYY/MM/DD'); // 1990/03/25

    To use the Arabic locale:

    Here is example:

        <!-- 1- Load the moment-with-locales -->
        <script src="http://momentjs.com/downloads/moment-with-locales.min.js"></script> 
        <script src="https://raw.githubusercontent.com/xsoh/moment-hijri/master/moment-hijri.js"></script> 
        
        <script>
          moment.locale('ar-SA');// 2- Set the global locale to `ar-SA`
          m = moment();
          m.format('iYYYY/iM/iDهـ الموافق YYYY/M/Dم'); //3- use it normally 
          //١٤٣٧/٨/١٧هـ الموافق ٢٠١٦/٥/٢٤م
        </script> 

    Acknowledgements

    This project was built from the great work done by @behrang whose behind moment-jalaali project.

    License

    MIT

    Install

    npm i moment-hijri

    DownloadsWeekly Downloads

    4,283

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    66 kB

    Total Files

    9

    Last publish

    Collaborators

    • xsoh