@sarmay/web-ime

1.1.6 • Public • Published

@Sarmay/Web-IME

English | 简体中文

This is a tool that is responsible for converting the content entered by the user in the input box into other characters

npm version Build Status Coverage Status install size GitHub issues GitHub forks GitHub stars

Installing

Using npm:

$ npm install @sarmay/web-ime

Using yarn:

$ yarn add @sarmay/web-ime

Using jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/@sarmay/web-ime/dist/index.js"></script>

Using unpkg CDN:

<script src="https://unpkg.com/@sarmay/web-ime/dist/index.js"></script>

Example

Parameters: LanguageOptions <String>

kz => kazakh for china;
kk => kazakh for kazakhstan;
latin => latin for china or kazakhstan;
ug => Uyghur for china;
kg => Kirgiz for china;

Parameters: $event <Event>

An event can be triggered by the user action e.g. clicking the mouse button or tapping keyboard

for Vue

  • note: React / Angular As the same below
<template>
  <div>
    <input v-model="value" @keydown="keydownHandel"></input>
  </div>
</template>
<script>
  import webIME from '@sarmay/web-ime'
  export default {
  name: 'WebIME',
  data() {
    return {
      value: '',
      defaultLang: 'kz',
      langOptions: [{
        value: 'kz',
        label: 'Kazakh for china'
      }, {
        value: 'kk',
        label: 'Kazakh for kazakhstan'
      }, {
        value: 'latin',
        label: 'latin for china or kazakhstan'
      }, {
        value: 'ug',
        label: 'Uyghur'
      }, {
        value: 'kg',
        label: 'Kirgiz'
      }]
    }
  },

  methods: {
    keydownHandel(event) {
      const { value } = webIME(this.defaultLang, event)
      console.log(value)
    }
  }
}
</script>

for Html script

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>@Sarmay/web-ime</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.js"></script>
    <!--  or load from  jsdelivr
      <script src="https://cdn.jsdelivr.net/npm/@sarmay/web-ime/dist/index.js"></script>
    -->
  </head>
  <body>
    <div>
      <textarea name="test" id="test" cols="50" rows="10"></textarea>
    </div>
    <script>
      var defaultLang= 'kz'; /** more option look langOptions */
      var test = document.getElementById('test');
      test.addEventListener("keydown", function(event) {
         const { value } = sarmayIme(defaultLang, event);
         console.log(value)
      });
    </script>
  </body>
</html>

License

MIT

Package Sidebar

Install

npm i @sarmay/web-ime

Weekly Downloads

5

Version

1.1.6

License

MIT

Unpacked Size

13.8 kB

Total Files

5

Last publish

Collaborators

  • sarmay