Keyboard
组件类型:UxKeyboardComponentPublicInstance
支持数字键盘、字母键盘、计算器键盘、密码键盘、安全键盘、车牌键盘
平台兼容性
UniApp X
| Android | iOS | web | 鸿蒙 Next | 小程序 |
|---|---|---|---|---|
| √ | √ | √ | √ | √ |
UniApp Vue Nvue
| Android | iOS | web | 鸿蒙 Next | 小程序 |
|---|---|---|---|---|
| x | x | √ | x | x |
Props
| 属性名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| theme | String | primary | 主题 |
| mode | String | number | 模式 |
| showSub | Boolean | true | 显示负号数字键盘有效 |
| showPoint | Boolean | true | 显示点数字键盘有效 |
| showNum | Boolean | true | 显示数字键盘字母键盘有效 |
| showSymbol | Boolean | true | 显示标点符号字母键盘和密码键盘有效 |
| showSapce | Boolean | true | 等于false时,空格不起作用,但是占位还在 |
| encrypt | Boolean | true | 加密显示安全键盘有效 |
| verify | Boolean | true | 内容合理性校验 |
| upper | Boolean | false | 保持字母大写显示字母键盘有效 |
| scrollId | String | scoll-view或list-view的Id | |
| adjustPosition | String | 键盘弹起时滚动到目标Id需配置父级IDscrollId | |
| maxLength | Number | -1不限制 | 输入最大长度 |
| inputSize | Any | 15 | 输入内容大小 |
| inputColor | String | #999 | 输入内容颜色 |
| inputDarkColor | String | 深色none-不显示,auto-自动适配深色模式,其他-颜色 | |
| placeholder | String | 占位内容 | |
| size | Any | 20 | 按钮文字大小 |
| color | String | #333 | 按钮文字颜色 |
| darkColor | String | 深色none-不显示,auto-自动适配深色模式,其他-颜色 | |
| btnColor | String | 按钮背景颜色 | |
| btnDarkColor | String | 深色none-不显示,auto-自动适配深色模式,其他-颜色 | |
| confirmText | String | 确定按钮文字 | |
| confirmColor | String | 确定按钮背景颜色 | |
| confirmDarkColor | String | 深色none-不显示,auto-自动适配深色模式,其他-颜色 | |
| spaceText | String | 空格按钮文字 | |
| background | String | 背景颜色 | |
| backgroundDark | String | 深色none-不显示,auto-自动适配深色模式,其他-颜色 | |
| showClose | Boolean | true | 显示关闭按钮 |
| radius | Any | 20 | 圆角 |
| opacity | Number | 0.2 | 遮罩透明度0-1 |
| touchable | Boolean | false | 允许滑动关闭 |
| maskClose | Boolean | true | 遮罩层关闭 |
| disabled | Boolean | false | 是否禁用 |
theme
| 值 | 说明 |
|---|---|
| text | 文字 |
| info | 默认 |
| primary | 主要 |
| success | 成功 |
| warning | 警告 |
| error | 错误 |
mode
| 值 | 说明 |
|---|---|
| number | 数字键盘 |
| letter | 英文字母键盘 |
| calculator | 计算器键盘 |
| safety | 安全键盘 |
| platenumber | 车牌键盘 |
inputDarkColor
| 值 | 说明 |
|---|---|
| none不显示 | |
| auto自动适配深色模式 | |
| color其他颜色 |
darkColor
| 值 | 说明 |
|---|---|
| none不显示 | |
| auto自动适配深色模式 | |
| color其他颜色 |
btnDarkColor
| 值 | 说明 |
|---|---|
| none不显示 | |
| auto自动适配深色模式 | |
| color其他颜色 |
confirmDarkColor
| 值 | 说明 |
|---|---|
| none不显示 | |
| auto自动适配深色模式 | |
| color其他颜色 |
backgroundDark
| 值 | 说明 |
|---|---|
| none不显示 | |
| auto自动适配深色模式 | |
| color其他颜色 |
touchable
| 值 | 说明 |
|---|---|
| true | |
| false |
maskClose
| 值 | 说明 |
|---|---|
| true | |
| false |
Events
| 事件名 | 说明 | 参数 |
|---|---|---|
| change | 输入时触发 | |
| confirm | 确定时触发 | |
| close | 关闭时触发 | |
| overlimit | 超出字数限制时触发 |
示例代码
html
<template>
<ux-page :stack="showDoc">
<ux-navbar :title="title" :bold="true">
<template v-slot:right>
<!-- #ifndef MP -->
<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
<!-- #endif -->
</template>
</ux-navbar>
<ux-scroll id="keyboardScroll">
<ux-card direction="column" icon="flag-filled" title="键盘" :bold="true">
<ux-text text="支持数字键盘、字母键盘、计算器键盘、安全键盘、车牌键盘"></ux-text>
</ux-card>
<ux-card direction="column" icon="arrowright" title="数字键盘" :bold="true">
<ux-keyboard mode="number" v-model="content1" :max-length="10" :show-sub="true" placeholder="支持光标插入" @overlimit="overlimit">
<ux-input v-model="content1" :readonly="true" placeholder="数字键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card direction="column" icon="arrowright" title="字母键盘" :bold="true">
<ux-keyboard mode="letter" v-model="content2" :upper="false" :show-num="true" :show-symbol="true" :show-sapce="true" placeholder="支持光标插入">
<ux-input v-model="content2" :readonly="true" placeholder="字母键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key1" direction="column" icon="arrowright" title="计算器键盘" :bold="true">
<ux-keyboard mode="calculator" v-model="content3" scroll-id="keyboardScroll" adjust-position="key1">
<ux-input v-model="content3" :readonly="true" placeholder="计算器键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key2" direction="column" icon="arrowright" title="安全键盘" :bold="true">
<ux-keyboard mode="safety" :encrypt="true" v-model="content4" scroll-id="keyboardScroll" adjust-position="key2" placeholder="安全键盘 放心输入">
<ux-input v-model="content4" :readonly="true" placeholder="安全键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key3" direction="column" icon="arrowright" title="车牌键盘" :bold="true">
<ux-keyboard mode="platenumber" v-model="platenumber" scroll-id="keyboardScroll" adjust-position="key3">
<ux-input v-model="platenumber" :readonly="true" placeholder="车牌键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-placeholder :height="400">
<ux-row justify="center" align="center" style="height: 100%;">
<ux-text prefix-icon="soapbubble-filled" text="真的没有了~"></ux-text>
</ux-row>
</ux-placeholder>
</ux-scroll>
<ux-toast ref="uxToastRef" position="top"></ux-toast>
</ux-page>
</template><template>
<ux-page :stack="showDoc">
<ux-navbar :title="title" :bold="true">
<template v-slot:right>
<!-- #ifndef MP -->
<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
<!-- #endif -->
</template>
</ux-navbar>
<ux-scroll id="keyboardScroll">
<ux-card direction="column" icon="flag-filled" title="键盘" :bold="true">
<ux-text text="支持数字键盘、字母键盘、计算器键盘、安全键盘、车牌键盘"></ux-text>
</ux-card>
<ux-card direction="column" icon="arrowright" title="数字键盘" :bold="true">
<ux-keyboard mode="number" v-model="content1" :max-length="10" :show-sub="true" placeholder="支持光标插入" @overlimit="overlimit">
<ux-input v-model="content1" :readonly="true" placeholder="数字键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card direction="column" icon="arrowright" title="字母键盘" :bold="true">
<ux-keyboard mode="letter" v-model="content2" :upper="false" :show-num="true" :show-symbol="true" :show-sapce="true" placeholder="支持光标插入">
<ux-input v-model="content2" :readonly="true" placeholder="字母键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key1" direction="column" icon="arrowright" title="计算器键盘" :bold="true">
<ux-keyboard mode="calculator" v-model="content3" scroll-id="keyboardScroll" adjust-position="key1">
<ux-input v-model="content3" :readonly="true" placeholder="计算器键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key2" direction="column" icon="arrowright" title="安全键盘" :bold="true">
<ux-keyboard mode="safety" :encrypt="true" v-model="content4" scroll-id="keyboardScroll" adjust-position="key2" placeholder="安全键盘 放心输入">
<ux-input v-model="content4" :readonly="true" placeholder="安全键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-card id="key3" direction="column" icon="arrowright" title="车牌键盘" :bold="true">
<ux-keyboard mode="platenumber" v-model="platenumber" scroll-id="keyboardScroll" adjust-position="key3">
<ux-input v-model="platenumber" :readonly="true" placeholder="车牌键盘"></ux-input>
</ux-keyboard>
</ux-card>
<ux-placeholder :height="400">
<ux-row justify="center" align="center" style="height: 100%;">
<ux-text prefix-icon="soapbubble-filled" text="真的没有了~"></ux-text>
</ux-row>
</ux-placeholder>
</ux-scroll>
<ux-toast ref="uxToastRef" position="top"></ux-toast>
</ux-page>
</template>ts
<script setup>
import * as plus from '@/uni_modules/ux-plus'
import { $ux } from '@/uni_modules/ux-frame'
import { UxToastData } from '@/uni_modules/ux-frame'
const title = ref('')
const content1 = ref('')
const content2 = ref('')
const content3 = ref('')
const content4 = ref('')
const platenumber = ref('')
const uxToastRef = ref<UxToastComponentPublicInstance | null>(null)
function overlimit(len: number) {
uxToastRef.value?.$callMethod('push', {
id: $ux.Random.uuid(),
logo: '/static/logo.png',
content: `超出字数限制:${len}`,
} as UxToastData)
}
const showDoc = ref(false)
function onDoc() {
plus.openWeb({
title: '在线文档',
url: 'https://www.uxframe.cn/component/keyboard.html',
// blur: 1,
success: () => {
showDoc.value = true
},
complete: () => {
showDoc.value = false
}
})
}
onLoad((e: OnLoadOptions) => {
title.value = e['title'] ?? ''
})
</script><script setup>
import * as plus from '@/uni_modules/ux-plus'
import { $ux } from '@/uni_modules/ux-frame'
import { UxToastData } from '@/uni_modules/ux-frame'
const title = ref('')
const content1 = ref('')
const content2 = ref('')
const content3 = ref('')
const content4 = ref('')
const platenumber = ref('')
const uxToastRef = ref<UxToastComponentPublicInstance | null>(null)
function overlimit(len: number) {
uxToastRef.value?.$callMethod('push', {
id: $ux.Random.uuid(),
logo: '/static/logo.png',
content: `超出字数限制:${len}`,
} as UxToastData)
}
const showDoc = ref(false)
function onDoc() {
plus.openWeb({
title: '在线文档',
url: 'https://www.uxframe.cn/component/keyboard.html',
// blur: 1,
success: () => {
showDoc.value = true
},
complete: () => {
showDoc.value = false
}
})
}
onLoad((e: OnLoadOptions) => {
title.value = e['title'] ?? ''
})
</script>css
<style lang="scss">
</style><style lang="scss">
</style>