Skip to content

salisa/persian.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A simple JavaScript library for Persian language localization.
Build Status

##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

##Functions

###1) Convert to Persian characters

Used for converting Arabic characters to Persian.

Example:

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

###2) Convert to Persian numbers

Used for converting Arabic numbers to Persian.

Example:

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

###3) 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(); //returns https://fa.wikipedia.org/wiki/صفحهٔ_اصلی

###4) ?

We're completing persian.js, if you need other functionalities, please create a issue on this repository and let us know that.
We will implement that as soon as possible!

##Roadmap

  • Convert English numbers to Persian
  • Zero-width non-joiner correction (e.g. convert می خواهم to می‌خواهم)
  • Make library configurable (e.g. setting the language)
  • Add uglifyjs to MakeFile in order to make .min version of script (Related to issue #7)

##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

##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.

About

A simple function to convert Arabic characters to Persian.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%