How does NgxPersian compare to moment-jalaali for handling Jalali dates in Angular?

NgxPersian provides an Angular-native JDate class and pipes, integrating seamlessly with Angular's change detection and templates, whereas moment-jalaali is a standalone JavaScript library that may require additional wrappers and lacks Angular-specific optimizations.

How to validate an Iranian national code in an Angular reactive form?

Use the NationalCodeService from NgxPersian to check validity via the isValid method, and integrate it with form validators. The README provides examples with services and directives for both reactive and template-driven forms.

Does NgxPersian support Angular 9 or higher?

The README states it's developed for Angular v4 to v7, so for newer versions, check the GitHub repository for updates or compatibility notes, as it might not be officially supported without modifications or community patches.

Can I use NgxPersian with server-side rendering (SSR) in Angular?

The library is built for client-side Angular applications, and the README doesn't address SSR compatibility. Jalali date calculations might need adjustment for server environments, so test thoroughly or look for community solutions.

How to format currency in Iranian Rial using NgxPersian?

Use the IRCurrency pipe by importing it in your module and applying it in templates, e.g., {{ value | irc:'R' }} for Rial formatting. The README details this with examples and optional parameters for customization.

Is NgxPersian maintained and updated regularly?

Yes, the README highlights that it's 'alive' with active maintenance, unlike other persian libraries with unanswered issues, but always verify the latest GitHub activity for recent updates and issue resolution.

Open-Awesome

ngx-persian

MITTypeScriptV2.0.1

A comprehensive Angular toolset for Persian applications, featuring Jalali date handling, number/letter conversion, and Iranian-specific validators.

GitHub

104 stars14 forks0 contributors

What is ngx-persian?

NgxPersian is an Angular library that provides a comprehensive set of tools for developing applications tailored for Persian-speaking users. It solves common localization challenges such as Jalali (Persian calendar) date handling, number/letter conversion between English/Arabic/Persian, and validation of Iranian-specific data like national codes and phone numbers.

Target Audience

Angular developers building applications for Iranian or Persian-speaking audiences, particularly those needing localized date handling, number formatting, and region-specific validations.

Value Proposition

Developers choose NgxPersian because it offers a complete, idiomatic Angular solution in one package, with thorough testing, active maintenance, and a design that integrates seamlessly with Angular's patterns, unlike fragmented or outdated alternatives.

Overview

A full-featured toolset for Persian Applications Created by Angular (v > 2) containing Pipes, Services, Directives, and javascript Similar Date object for working with Jalali Date.

Use Cases

Best For

Building Angular applications for the Iranian market
Handling Jalali (Persian calendar) dates in Angular apps
Converting between English, Arabic, and Persian digits/letters
Validating Iranian national codes and mobile phone numbers
Formatting currency values in Rial or Toman
Adding Persian-specific validators to Angular reactive or template-driven forms

Not Ideal For

Applications targeting international audiences outside Persian-speaking regions
Projects built on Angular versions later than v7 without confirmed compatibility
Teams requiring lightweight, single-purpose libraries for specific tasks like date conversion only
Developers needing multi-locale support beyond Persian and Iranian specifics

Pros & Cons

Pros

Comprehensive Persian Localization

Provides a full suite of pipes, services, and directives for number conversion, date handling, and Iranian validations, eliminating the need for multiple packages as emphasized in the README's 'Why you should use this library?' section.

Angular Idiomatic Integration

Built the 'Angular way' with native patterns like pipes and services, ensuring better integration and maintainability compared to wrapped JavaScript libraries, as stated in the philosophy.

Robust Testing and Maintenance

Features over 590 unit tests with 90% coverage and active maintenance, addressing issues promptly, which the README highlights as a key advantage over outdated alternatives.

Jalali Date Object

Offers a JDate class mimicking JavaScript's Date object for the Persian calendar, with timezone awareness and formatting pipes, solving common date-handling problems for Iranian developers.

Cons

Incomplete Documentation

The README badge shows documentation at 73%, indicating gaps that could hinder onboarding and advanced usage, despite claims of clarity.

Limited Angular Version Support

Explicitly developed for Angular v4 to v7 per the README, raising concerns about compatibility with newer versions unless updated, which might cause breaking changes.

Niche Scope and Complexity

Heavily focused on Persian and Iranian specifics, with verbose setup requiring module imports for pipes and services, making it less versatile for general or multi-locale applications.

Frequently Asked Questions

Related Projects

Official Angular Components repository

Component infrastructure and Material Design components for Angular

Stars25,035

Forks6,838

Last commit2 days ago

spartan

Cutting-edge tools powering Angular full-stack development.

Stars2,952

Forks326

Last commit6 days ago

rx-angular

Reactive Extensions for Angular.

Stars1,963

Forks209

Last commit8 days ago

ng-web-apis

A set of common utils for consuming Web APIs with Angular

Stars826

Forks39