armantaherian / persian.js

A simple library for Persian language localization.

A simple JavaScript library for Persian language localization.

##How to use Simply include persian.js in your HTML page and use the functions.
If your in production environment, use persian.min.js instead.

###In Node.js npm install persianjs ###In Bower bower install persianjs ##Functions

###1) Convert to Persian characters

Used for converting Arabic characters to Persian.

Example:

persianJs("علي").arabicChar().toString(); //returns: علی

###2) Convert to Persian numbers from Arabic Number

Used for converting Arabic numbers to Persian.

Example:

persianJs("٣٤٥").arabicNumber().toString(); //returns: ۳۴۵

###3) Convert to Persian numbers from English Number

Used for converting English numbers to Persian.

Example:

persianJs("345").englishNumber().toString(); //returns: ۳۴۵

###4) Fix Persian Characters in URLs

Used to convert unreadable Persian characters in URL to readable characters.

Example:

persianJs("https://fa.wikipedia.org/wiki/%D8%B5%D9%81%D8%AD%D9%87%D9%94_%D8%A7%D8%B5%D9%84%DB%8C").fixURL().toString(); //returns https://fa.wikipedia.org/wiki/صفحهٔ_اصلی

###5) Change keyboard layout

Used for converting Persian char to English char.

Example:

persianJs("لخخلمث").switchKey().toString(); //returns: google

###6) Fix zero-width space

Used for converting space to zero-width space.

Example:

persianJs("لانه ی | لانه های | لانه ای را تمیز می کنم.").switchKey().toString(); //returns: لانه‌ی | لانه‌های | لانه‌ای را تمیز می‌کنم.

###Chainable using

You can use all of the functions together with one PersianJs instance (in v0.3):

Example:

persianJs("علي٤2465").arabicChar().englishNumber().arabicNumber().toString(); //returns: علی۴۲۴۶۵

##Roadmap

• Make library configurable (e.g. setting the language)
• Add uglifyjs to MakeFile in order to make .min version of script (Related to issue #7)

##Main Contributors

• Afshin Mehrabani
• Sallar Kaboli
• Armin Ebrahimi
• Nima Shayafar
• Soheil Rashidi
• Bersam Karbasion
• Ali Sadattalab

other conributors: https://github.com/usablica/persian.js/contributors

###Special Thanks To Ali Ehsanfar for Logo design.

##Contributing

This is a open-source project. Fork the project, complete the code and send pull request.

##Getting support

• Google Groups forum
• Report bug/issues

##License

Copyright (C) 2012 Afshin Mehrabani ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions 
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
IN THE SOFTWARE.