Appearance
xtf-number-keyboard
组件说明
xtf-number-keyboard 是数字键盘，用于为金额、身份证等场景提供屏幕键盘。当前实现由 show 控制显示、通过 update:modelValue 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-number-keyboard/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfNumberKeyboard title="账单详情" :show="true">
<text class="doc-content-text">示例内容</text>
</XtfNumberKeyboard>
</view>
</template>
<script setup lang="uts">
import XtfNumberKeyboard from "@/uni_modules/xtf-linkuiunix/components/xtf-number-keyboard/xtf-number-keyboard.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfNumberKeyboard title="账单详情" :show="true" @input="onPrimaryEvent">
<text class="doc-content-text">示例内容</text>
</XtfNumberKeyboard>
</view>
</template>
<script setup lang="uts">
import XtfNumberKeyboard from "@/uni_modules/xtf-linkuiunix/components/xtf-number-keyboard/xtf-number-keyboard.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-number-keyboard:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>3. 动态 show 状态
运行时切换 show，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfNumberKeyboard title="账单详情" :show="state">
<text class="doc-content-text">示例内容</text>
</XtfNumberKeyboard>
<button class="doc-action-button" @click="toggleState">切换 show</button>
<text class="doc-state-text">show: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfNumberKeyboard from "@/uni_modules/xtf-linkuiunix/components/xtf-number-keyboard/xtf-number-keyboard.uvue"
import { ref } from "vue"
const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", state.value) }
</script>
<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>4. 定制 trigger 插槽
使用源码真实声明的 trigger slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfNumberKeyboard title="账单详情" :show="true">
<template #trigger="scope"><text class="doc-content-text">自定义 trigger 内容：{{ scope.value }}</text></template>
</XtfNumberKeyboard>
</view>
</template>
<script setup lang="uts">
import XtfNumberKeyboard from "@/uni_modules/xtf-linkuiunix/components/xtf-number-keyboard/xtf-number-keyboard.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 open()
打开组件；签名为 open(): void。
vue
<template>
<view class="doc-method">
<XtfNumberKeyboard title="账单详情" :show="true" ref="componentRef">
<text class="doc-content-text">示例内容</text>
</XtfNumberKeyboard>
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfNumberKeyboard from "@/uni_modules/xtf-linkuiunix/components/xtf-number-keyboard/xtf-number-keyboard.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 46、script 行 116 | 需要覆盖组件默认业务值时设置。 |
show | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 45、script 行 115 | 需要控制显示、可用性或交互状态时设置。 |
keyboardType | KeyboardType | "number" | 参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 54、script 行 55、script 行 57、script 行 59 | 需要覆盖组件默认业务值时设置。 |
maxlength | number | string | -1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 51 | 需要覆盖组件默认业务值时设置。 |
extraKey | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 56 | 需要覆盖组件默认业务值时设置。 |
showDoubleZero | boolean | false | 开关对应显示或交互行为；消费位置：script 行 57、script 行 64、script 行 105 | 需要控制显示、可用性或交互状态时设置。 |
randomKeyOrder | boolean | false | 参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 52、script 行 109、script 行 115、script 行 118 | 需要覆盖组件默认业务值时设置。 |
closeOnInputComplete | boolean | false | 开关对应显示或交互行为；消费位置：script 行 99 | 需要覆盖组件默认业务值时设置。 |
closeButtonText | string | "完成" | 设置对应区域的显示文案；消费位置：template 行 29、template 行 56 | 需要提供业务文案或图标内容时设置。 |
deleteButtonText | string | "删除" | 设置对应区域的显示文案；消费位置：template 行 29、template 行 55 | 需要提供业务文案或图标内容时设置。 |
overlay | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 15 | 需要控制显示、可用性或交互状态时设置。 |
closeOnClickOverlay | boolean | true | 开关对应显示或交互行为；消费位置：script 行 108 | 需要覆盖组件默认业务值时设置。 |
safeAreaInsetBottom | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 59 | 需要覆盖组件默认业务值时设置。 |
zIndex | number | 100 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 65 | 需要覆盖组件默认业务值时设置。 |
title | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 58、template 行 19 | 需要提供业务文案或图标内容时设置。 |
subtitle | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 58、template 行 20 | 需要提供业务文案或图标内容时设置。 |
theme | string | "default" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 59 | 需要调整布局或视觉表现时设置。 |
displayMode | string | "sheet" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 14 | 需要覆盖组件默认业务值时设置。 |
lockScroll | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 113 | 需要覆盖组件默认业务值时设置。 |
secureMode | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 62 | 需要覆盖组件默认业务值时设置。 |
randomAllNumbers | boolean | false | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 52、script 行 53、script 行 69、script 行 109 | 需要覆盖组件默认业务值时设置。 |
targetFocus | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 117 | 需要覆盖组件默认业务值时设置。 |
showCloseIcon | boolean | false | 设置对应区域的图标名称；消费位置：script 行 58、template 行 22 | 需要控制显示、可用性或交互状态时设置。 |
showTrigger | boolean | false | 开关对应显示或交互行为；消费位置：template 行 3 | 需要控制显示、可用性或交互状态时设置。 |
triggerLabel | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 7 | 需要提供业务文案或图标内容时设置。 |
triggerPlaceholder | string | "点击输入" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 62 | 需要提供业务文案或图标内容时设置。 |
triggerDisabled | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 60、script 行 107 | 需要覆盖组件默认业务值时设置。 |
triggerStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象；消费位置：template 行 6 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 59 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 16 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | updateValue 内触发（script 行 81）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
input | updateValue 内触发（script 行 82）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | updateValue 内触发（script 行 83）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:show | open 内触发（script 行 109）；参数表达式：trueclose 内触发（script 行 110）；参数表达式：false；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:targetFocus | open 内触发（script 行 109）；参数表达式：trueclose 内触发（script 行 110）；参数表达式：false；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
delete | removeLast 内触发（script 行 106）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
close | close 内触发（script 行 110）；参数表达式：无回调参数；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
blur | close 内触发（script 行 110）；参数表达式：无回调参数；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | confirm 内触发（script 行 111）；参数表达式：innerValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
complete | appendValue 内触发（script 行 98）；参数表达式：nextValue；前置 guard：value == "." && innerValue.value.indexOf(".") >= 0、props.keyboardType == "id-card" && (innerValue.value.length >= 18 || (value.toUpperCase() == "X" && innerValue.value.length != 17))、nextValue == innerValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
trigger-click | openFromTrigger 内触发（script 行 107）；参数表达式：无回调参数；前置 guard：props.triggerDisabled | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
open | open 内触发（script 行 109）；参数表达式：无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
target-focus | open 内触发（script 行 109）；参数表达式：无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
target-blur | close 内触发（script 行 110）；参数表达式：无回调参数；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
switch | switchPlate 内触发（script 行 112）；参数表达式：alphabetMode.value ? "alphabet" : "province" | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
key | appendValue 内触发（script 行 96）；参数表达式：value；前置 guard：value == "." && innerValue.value.indexOf(".") >= 0、props.keyboardType == "id-card" && (innerValue.value.length >= 18 || (value.toUpperCase() == "X" && innerValue.value.length != 17))、nextValue == innerValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
trigger | { value, open, open-keyboard, close } | 仅在模板对应 <slot> 渲染位置生效。 |
default | { value, open, open-keyboard, close } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件；通过组件 ref 调用，参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-mask)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface-muted)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-warning)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-opacity-disabled)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。