@sarmay/character-shaper
Version:
This is a Kazakh Arabic character shaper, which assists developers in correcting text in areas where the text is confusing. It is often used to enter Kazakh text normally on PhotoShop, PR and other software; it can also be used in nodejs image synthesis.
120 lines (96 loc) • 3.78 kB
Markdown
# @Sarmay/Character-Shaper
## [English](https://github.com/Sarmay/sarmay-character-shaper#readme) | 简体中文
### 这是一个哈萨克语阿拉伯文字字符定型器，辅助开发者在文字混乱的区域修正文字，常用于PhotoShop，PR等软件上正常输入哈萨克文字；也可以用在nodejs图片合成
[](https://www.npmjs.org/package/@sarmay/character-shaper)
[](https://www.travis-ci.com/Sarmay/sarmay-character-shaper) [](https://coveralls.io/github/Sarmay/sarmay-character-shaper?branch=main) [](https://packagephobia.now.sh/result?p=@sarmay/character-shaper)
[](https://github.com/Sarmay/sarmay-character-shaper/issues) [](https://github.com/Sarmay/sarmay-character-shaper/network) [](https://github.com/Sarmay/sarmay-character-shaper/stargazers)
# 安装
### 使用 npm:
```
$ npm install @sarmay/character-shaper
```
### 使用 yarn:
```
$ yarn add @sarmay/character-shaper
```
### 使用 jsDelivr CDN:
```
<script src="https://cdn.jsdelivr.net/npm/@sarmay/character-shaper/dist/index.min.js"></script>
```
### 使用 unpkg CDN:
```
<script src="https://unpkg.com/@sarmay/character-shaper/dist/index.min.js"></script>
```
# 使用
### 参数: `<String>`
```
新疆哈萨克-阿拉伯文文字
```
### 用于 Node
```
const shaper = require('@sarmay/character-shaper')
const value = shaper('سالەم سارماي')
console.log(value)
```
### 用于 Vue
- 提示: React / Angular 用法一样
```
<template>
<div>
<textarea v-model="value" name="sarmay-ime" id="sarmay-ime" cols="30" rows="10" @keydown="keydownHandel"></textarea>
<div>{{newValue}}</div>
</div>
</template>
<script>
import webIME from '@sarmay/web-ime'
import characterShaper from '@sarmay/character-shaper'
export default {
data() {
return {
value: '',
newValue: ''
}
},
methods: {
keydownHandel(event) {
const inputValue = webIME('kz', event)
this.newValue = characterShaper(inputValue)
}
}
}
</script>
```
### 用于 Html script
```
<html lang="en">
<head>
<meta charset="utf-8" />
<title>@Sarmay/character-shaper</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- load from unpkg -->
<script src="https://unpkg.com/@sarmay/web-ime/dist/index.min.js"></script>
<script src="https://unpkg.com/@sarmay/character-shaper/dist/index.min.js"></script>
<!-- or load from jsdelivr
<script src="https://cdn.jsdelivr.net/npm/@sarmay/web-ime/dist/index.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@sarmay/character-shaper/dist/index.min.js"></script>
-->
</head>
<body>
<div>
<textarea name="values" id="values" cols="50" rows="10"></textarea>
<div id="show"></div>
</div>
<script>
var values = document.getElementById('values');
var show = document.getElementById('show');
values.addEventListener("keydown", function(event) {
var newValue = sarmayIme('kz', event);
show.innerText = sarmayCharacterShaper(newValue)
});
</script>
</body>
</html>
```
## License
[MIT](LICENSE)