Package Exports

knayi-myscript

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (knayi-myscript) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Knayi Myanmar Script

Standalone Myanmar languages JavaScript library, use to build Myanmar Unicode standard easily.

Node Version

Required node version >= 4
Note: From version >=2.3.0 build step will only support for node >=6

Features

Detector (Unicode and Zawgyi)
Converter (Unicode and Zawgyi)
SyallBreak (Unicode and Zawgyi)
Spelling Check (Unicode and Zawgyi)

Installation

Using npm

npm install knayi-myscript --save

Using yran

yarn add knayi-myscript

Using CDN

<script src="https://unpkg.com/knayi-myscript@2.2.0/dist/knayi-myscript.min.js"></script>

API

Method Name	Arguments	Return	Note
`fontDetect`	`content: String(require)`	`String`	Font Detector, it will detect unicode/zawgyi of the content Text. If nothing is matched or possibility are equal, it will return as 'zawgyi' or specified font type in defaultFont params.
`fontConvert`	`content: String(require)`, `convertTo: fontName(require)`, `convertFrom: fontName(optional)`	`String`	Converting font to target font type. This method need spelling fix, so it gonna use spellingFix in default. convertFrom will be detect by fontDetect when you don't described. `fontName` must be one of `unicode` or `zawgyi`.
`syllBreak`	`content: String(require)`, `fontType: fontName(optional)`, `breakPoint: String(optional)`	`String`	To make systematic word break of Myanmar text. convertFrom will be detect by fontDetect when you don't described. `fontName` must be one of `unicode` or `zawgyi`.
`spellingFix`	`content: String(require)`, `fontType: fontName(optional)`	`String`	convertFrom will be detect by fontDetect when you don't described. It fix spelling on Myanmar Text. `fontName` must be one of `unicode` or `zawgyi`.

Usage

// ES5 Way
var knayi = require('knayi-myscript')

// ES6 Way
import knayi from 'knayi-myscript'

Example

fontDetect(content, [defaultFont])

knayi.fontDetect('မဂၤလာပါ') // zawgyi
knayi.fontDetect('မင်္ဂလာပါ') // unicode

fontConvert(content, convertTo, [convertFrom])

knayi.fontConvert('မဂၤလာပါ', 'unicode', 'zawgyi') // မင်္ဂလာပါ
knayi.fontConvert('မဂၤလာပါ', 'unicode') // မင်္ဂလာပါ

syllBreak(content, [fontType] [,breakPoint])

knayi.syllBreak('မင်္ဂလာပါ', null, '$$') // 'မင်္ဂလာ$$ပါ'

spellingFix(content, [fontType])

knayi.spellingFix('မင်္ဂလာာပါါ') // 'မင်္ဂလာပါ'

Build

Required node >=6
npm run build
To build production run webpack -p

License

MIT