free-keyboard/README.md

为vue量身定做的、功能完善的、提供丰富自定义功能的前端键盘组件

# free-keyboard
> 自定义键盘插件。 包含纯数字键盘、自定义数字键盘、英文键盘

### 推荐node版本
```
不小于8.9.0
```

### 使用
``` main.js
npm install free-keyboard

import FreeKeyboard from 'free-keyboard';
Vue.use(FreeKeyboard);
```

```xxx.vue
this.$keyboard({
   type: 'english', // 当前默认调起的键盘类型  english英文 number数字 customNum自定义数字
   el: {}, // 当前输入框Dom对象
   value: '', // input值
   maxLength: 20, // 更新input本身最大字符长度maxLength，如果没有设置，默认长度为20字符
   switchKey: true, // 是否可以切换英文数字键盘 true 默认可以
   customKeys: ["@", "_", ".", "!", "%", "*", "/", "+"], // 用户自定义字符 最大限制8种
});

```


### 相关性能指标
|  指标字段 | 类型 | 默认值  | 描述  |
|  ----  |----  | ----  | ----  |
| type | string | english | 默认调起的键盘类型 |
| el | - | - | 当前输入框DOM对象 |
| value | string/number | - | input值 |
| maxLength | number | 20 | 更新input本身最大字符长度maxLength，如果没有设置，默认长度为20字符 |
| switchKey | boolean | true | 是否可以切换英文数字键盘 true 默认true(可以) |
| customKeys | Array | - | 用户自定义字符 最大限制8种 |