jalali-moment

jalali-moment

It adds jalali (Persian, Khorshidi, Shamsi) calendar system to moment.js library. DEMO

jalali calendar is a solar calendar. It gains approximately 1 day on the Julian calendar every 128 years. Read more on Wikipedia.

Calendar conversion is based on the algorithm provided by Kazimierz M. Borkowski and has a very good performance.

Install

Install via npm

npm install jalali-moment -S

Install via yarn

yarn add jalali-moment

Install via bower

bower install jalali-moment --save

Using in Node.js

install it via npm or yarn and following code will work

var moment = require('jalali-moment');
moment().format('jYYYY/jM/jD');

Using in browser

ES5

<!--<script src="bower_components/jalali-moment/dist/jalali-moment.browser.js"></script>-->
<!--<script src="node_modules/jalali-moment/dist/jalali-moment.browser.js"></script>-->
<script src="thisRepositoryPath/dist/jalali-moment.browser.js"></script>
<script>
  moment().format('jYYYY/jM/jD');
</script>

Typescript

import * as moment from 'jalali-moment';
let todayJalali = moment().format('jYYYY/jM/jD');

Angular

import * as moment from 'jalali-moment';

add a jalali pipe

@Pipe({
  name: 'jalali'
})
export class JalaliPipe implements PipeTransform {
  transform(value: any, args?: any): any {
    let MomentDate = moment(value);
    return MomentDate.format("jYYYY/jM/jD");
  }
}

and use it in component template

 <div>{{ loadedData.date | jalali }}</div>

Using in Plunker

####ES5

<script src='https://unpkg.com/jalali-moment/dist/jalali-moment.browser.js'></script>
<script>
  moment().format('jYYYY/jM/jD');
</script>

####Typescript or es6

You could use systemjs to import this library into your project like this

API

This plugin tries to mimic moment.js api. Basically, when you want to format or parse a string, just add a j to the format token like 'jYYYY' or 'jM'. For example:

now = moment(); //get the current date and time,
m = moment('1367/11/4', 'jYYYY/jM/jD');
m.format('jYYYY/jM/jD [is] YYYY/M/D'); // 1367/11/4 is 1989/1/24
m.jDayOfYear(); // 310
m.jWeek(); // 45
m.jWeekYear(); // 1367
moment.jIsLeapYear(m.jYear()); // false
m.jYear(1368); // set jalali year
//  If the range is exceeded, it will bubble up to the year.
m.jMonth(3); // month will be 4 and m.format("M")=='4' , jMonth Accepts numbers from 0 to 11.
m.jDate(10); // set a date
m.format("jYYYY/jMM/jD"); // 1368/4/10
m.subtract(1, "jyear"); // add a Jalali Year
m.format("jYYYY/jMM/jD"); // 1367/4/10
m.add(2, "jmonth"); // add Jalali Month
m.format("jYYYY/jMM/jD"); // 1367/6/10

moment('1392/6/3 16:40', 'jYYYY/jM/jD HH:mm')
    .format('YYYY-M-D HH:mm:ss'); // 2013-8-25 16:40:00

moment('2013-8-25 16:40:00', 'YYYY-M-D HH:mm:ss')
    .endOf('jMonth')
    .format('jYYYY/jM/jD HH:mm:ss'); // 1392/6/31 23:59:59

moment('1981 5 17', 'YYYY jM D')
    .format('YYYY/MM/DD'); // 1981/07/17

all features are documented in here.

Load Persian

To add Persian language, use loadPersian method:

moment().format('jYYYY/jMMMM/jD'); // 1367/Bahman/4
moment.loadPersian();
moment().format('jYYYY/jMMMM/jD'); // 1367/بهمن/4
moment.loadPersian(true); //use persian digits
moment().format('jYYYY/jMMMM/jD'); // ۱۳۶۷/بهمن/۴
moment.unloadPersian();
moment().format('jYYYY/jMMMM/jD'); // 1367/Bahman/4

Use jalali calendar system primarily

This plugin adds Jalali calendar system to moment.js which is using gregorian calendar system so we could use both calendar system concurrently but you could use Jalali calendar as default system like the following code:

    moment().format('YYYY/MMMM/D'); // 1989/January/24
    moment.useJalaliSystemPrimarily();
    
    moment().format('YYYY/MMMM/D'); // 1367/Bahman/4
    moment().subtract(1,'year').format('YYYY/MMMM/D'); // 1366/bahman/4
    moment().subtract(1,'month').format('YYYY/MMMM/D'); // 1367/dey/4
    
    moment.useJalaliSystemSecondary();
    moment().format('YYYY/MMMM/D'); // 1989/January/24

For example: to make a datepicker work with jalali calendar system you could use this feature.

Related Projects

jalaali-moment

A Jalaali calendar system plugin for moment.js.

jalali-angular-datepicker ( angular2 or more)

A highly configurable date picker built for Angular 4 or Angular 2 applications using jalali-moment is fingerpich/jalali-angular-datepicker created by @Fingerpich.

License

MIT