Home

数字键盘

用于手机浏览器的虚拟的可自定义数字键盘，它包含一个可以调起虚拟自定义数字键盘的文本框，支持大部分的 HTML5 标准属性和光标操作。同时，虚拟键盘本身可以单独和其他自定义输入界面一起使用，比如互联网金融场景常见的数字验证码输入方格。

数字键盘拥有多个版本：纯 JavaScript 类，React 组件和 Vue 组件。

🎥 观看演示视频 ☀️

目录

• 安装
• 使用
• 键盘
• 贡献
• 许可证

安装

通过 Yarn 安装

yarn add numeric-keyboard

配置 Webpack 使用恰当的版本

resolve: {
  alias: {
    // 以 **Vue** 为例
    'numeric-keyboard$': 'numeric-keyboard/dist/numeric_keyboard.vue.js'
  }
},

使用

JavaScript

import { NumericInput } from 'numeric-keyboard'
new NumericInput('.input', {
  type: 'number',
  placeholder: 'touch to input',
  onInput(value) {
    ...
  }
})

React

import { NumericInput } from 'numeric-keyboard'
class App extends React.Component {
  input(val) {
    ...
  },
  render() {
    return <div className="input">
      <label>Amount: </label>
      <NumericInput type="number" placeholder="touch to input" onInput={this.input.bind(this)} />
    </div>
  }
}

Vue

<template>
  <div class="input">
    <label>Amount: </label>
    <NumericInput placeholder="touch to input" v-model="amount" />
  </div>
</template>

<script>
  import { NumericInput } from 'numeric-keyboard'
  export default {
    components: {
      NumericInput
    },
    data() {
      return {
       amount: null
      }
    }
  }
</script>

选项/属性

虚拟文本框用以替换原生的输入框，所以它支持大部分标准属性，详情可参看 HTML 标准文档。

// 只支持两种输入类型：number 和 tel
// 它调起的键盘组件的 layout 属性默认和它一致，详情可参考后面详细的键盘配置
type: {
  type:String,
  default: 'number'
},
autofocus: {
  type: Boolean,
  default: false
},
disabled: {
  type: Boolean,
  default: false
},
maxlength: {
  type: Number
},
name: {
  type: String
},
placeholder: {
  type: String
},
readonly: {
  type: Boolean,
  default: false
},
value: {
  type: [String, Number]
},
// 使用一个正则表达式或者函数限制输入内容
format: {
  type: [String, Function]
},
// 配置它调起的键盘组件，详细配置参考后面内容
keyboard: {
  type: Object
}

回调函数/事件

input

当输入发生改变时会触发 input 事件，和原生输入框元素触发的事件不同，响应函数的第一个参数并不是事件对象，而是输入框内文本的值。当使用原生 JavaScript 版本时，使用 onInput() 回调函数代替 input 事件。

键盘

虚拟数字键盘本身是一个独立的可插拔组件，可自定义布局和样式，通常它需要和一个输入界面一起使用。

使用

Plain JavaScript

import { NumericKeyboard } from 'numeric-keyboard'
new NumericKeyboard('.keyboard', {
  layout: 'tel',
  onPress(key) {
    ...
  }
})

React

import { NumericKeyboard } from 'numeric-keyboard'
class App extends React.Component {
  press(key) {
    ...
  }
  render() {
    return <div className="keyboard">
      <NumericKeyboard layout="tel" onPress={this.press.bind(this)} />
    </div>
  }
}

Vue

<template>
   <div class="keyboard">
     <NumericKeyboard layout="tel" @press="press" />
   </div>
</template>

<script>
  import { NumericKeyboard } from 'numeric-keyboard'
  export default {
    components: {
      NumericKeyboard
    },
    methods: {
      press(key) {
        ...
      }
    }
  }
</script>

选项/属性

// 修改键盘的布局
 layout: {
   type: [String, Array],
   default: 'number'
 },
 // 修改键盘主题
 theme: {
   type: [String, Object],
   default: 'default'
 },
 // 自定义确认按钮文本，主要用于自定义使用场景和语言
 entertext: {
   type: String,
   default: 'enter'
 }

layout

有两种内置的布局： number 和 tel 对应两种标准输入类型。你可以自定义任何布局样式，数字键盘使用一个二维数组构建了一种表格布局，支持单元格合并。

number 布局

tel 布局

自定义布局

// 内置 number 布局代码示例
import { keys } from 'numeric-keyboard'
[
  [
    {
      key: keys.ONE
    },
    {
      key: keys.TWO
    },
    {
      key: keys.THREE
    },
    {
      key: keys.DEL,
      rowspan: 2,
    },
  ],
  [
    {
      key: keys.FOUR
    },
    {
      key: keys.FIVE
    },
    {
      key: keys.SIX
    },
  ],
  [
    {
      key: keys.SEVEN
    },
    {
      key: keys.EIGHT
    },
    {
      key: keys.NINE
    },
    {
      key: keys.ENTER,
      rowspan: 2,
    },
  ],
  [
    {
      key: keys.DOT
    },
    {
      key: keys.ZERO
    },
    {
      key: keys.ESC
    },
  ],
]

theme

修改键盘主题样式，可全局修改或者只针对某个按键。目前只支持文字颜色和背景颜色的修改，其他复杂的样式可直接覆盖 CSS 样式表。

// 默认样式定义
import { keys } from 'numeric-keyboard'
{
  global: {
    color: '#000000',
    backgroundColor: ['#ffffff', '#929ca8'], // 数组内第二个样式用于配置 active 伪类
  },
  key: {
    [keys.ENTER]: {
      color: '#ffffff',
      backgroundColor: ['#007aff', '#0051a8'],
    },
  }
}

回调函数/事件

press

点击键盘按键时会触发 press 事件，响应函数的参数是刚刚点击过的按键。当使用原生 JavaScript 版本时，使用 onPress() 回调函数代替 press 事件。

贡献

欢迎一起参与开发，规范正在制定中...

许可证

Licensed under the MIT license.