feat(NumberKeyboard): use delete icon instead of delete text (#6151)

This commit is contained in:
neverland
2020-04-27 19:14:44 +08:00
committed by GitHub
parent 3360ca7eb0
commit 9e7d72eff2
10 changed files with 464 additions and 431 deletions
+53 -52
View File
@@ -2,7 +2,7 @@
### 介绍
数字键盘,提供两种样式风格,可以与[密码输入框](#/zh-CN/password-input)或自定义的输入框组件配合使用
数字虚拟键盘,可以配合[密码输入框组件](#/zh-CN/password-input)或自定义的输入框组件使用
### 引入
@@ -17,14 +17,14 @@ Vue.use(NumberKeyboard);
### 默认样式
数字键盘提供了 `input``delete``blur` 事件,分别对应输入内容、删除内容和失去焦点的动作
```html
<van-button @touchstart.stop="show = true">
<van-cell @touchstart.native.stop="show = true">
弹出默认键盘
</van-button>
</van-cell>
<van-number-keyboard
:show="show"
extra-key="."
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
@@ -51,7 +51,11 @@ export default {
};
```
### 自定义样式
> 点击键盘以外的区域时,键盘会自动收起,通过阻止元素上的 touchstart 事件冒泡可以避免键盘收起。
### 带右侧栏的键盘
将 theme 属性设置为 `custom` 来展示键盘的右侧栏,常用于输入金额的场景
```html
<van-number-keyboard
@@ -65,9 +69,46 @@ export default {
/>
```
### 身份证号键盘
通过 `extra-key` 属性可以设置左下角按键内容,比如需要输入身份证号时,可以将 `extra-key` 设置为 `X`
```html
<van-cell plain type="primary" @touchstart.native.stop="show = true">
弹出身份证号键盘
</van-cell>
<van-number-keyboard
:show="show"
extra-key="X"
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
```
### 键盘标题
通过 `title` 属性可以设置键盘标题
```html
<van-cell plain type="info" @touchstart.native.stop="show = true">
弹出带标题的键盘
</van-cell>
<van-number-keyboard
:show="show"
title="键盘标题"
extra-key="."
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
```
### 双向绑定
可以通过`v-model`绑定键盘当前输入值
可以通过 `v-model` 绑定键盘当前输入值
```html
<van-field
@@ -76,7 +117,6 @@ export default {
:value="value"
@touchstart.native.stop="show = true"
/>
<van-number-keyboard
v-model="value"
:show="show"
@@ -96,62 +136,23 @@ export default {
};
```
### 左下角按键内容
通过`extra-key`属性可以设置左下角按键内容
```html
<van-button plain type="primary" @touchstart.stop="show = true">
弹出身份证号码键盘
</van-button>
<van-number-keyboard
:show="show"
close-button-text="完成"
extra-key="X"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
```
### 键盘标题
通过`title`属性可以设置键盘标题
```html
<van-button plain type="info" @touchstart.stop="show = true">
弹出自定义标题键盘
</van-button>
<van-number-keyboard
:show="show"
close-button-text="完成"
title="键盘标题"
extra-key="."
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| v-model `v2.0.2` | 当前输入值 | _string_ | - |
| v-model (value) `v2.0.2` | 当前输入值 | _string_ | - |
| show | 是否显示键盘 | _boolean_ | - |
| theme | 样式风格,可选值为 `default` `custom` | _string_ | `default` |
| theme | 样式风格,可选值为 `custom` | _string_ | `default` |
| title | 键盘标题 | _string_ | - |
| maxlength `v2.0.2` | 输入值最大长度 | _number \| string_ | - |
| transition | 是否开启过场动画 | _boolean_ | `true` |
| z-index | 键盘 z-index | _number \| string_ | `100` |
| extra-key | 左下角按键内容 | _string_ | `''` |
| close-button-text | 关闭按钮文字,空则不展示 | _string_ | `-` |
| delete-button-text | 删除按钮文字 | _string_ | `删除` |
| show-delete-key `v2.5.9` | 是否展示删除按钮 | _boolean_ | `true` |
| close-button-text | 关闭按钮文字,空则不展示 | _string_ | - |
| delete-button-text | 删除按钮文字,空则展示删除图标 | _string_ | - |
| show-delete-key `v2.5.9` | 是否展示删除图标 | _boolean_ | `true` |
| hide-on-click-outside | 点击外部时是否收起键盘 | _boolean_ | `true` |
| safe-area-inset-bottom | 是否开启[底部安全区适配](#/zh-CN/quickstart#di-bu-an-quan-qu-gua-pei) | _boolean_ | `true` |