Skip to content

xtf-number-box ​

组件说明 ​

xtf-number-box 是数字输入框,用于通过输入和步进按钮编辑受限数值。当前实现通过 input 等事件反馈交互、提供实例方法。

  • 实际 Demo 路由:#/pages/components/xtf-number-box/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

提供能够直接看到或操作组件的最少业务内容。

vue
<template>
  <view class="doc-minimum">
    <XtfNumberBox :value="2" />
  </view>
</template>

<script setup lang="uts">
import XtfNumberBox from "@/uni_modules/xtf-linkuiunix/components/xtf-number-box/xtf-number-box.uvue"

</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口,并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfNumberBox :value="2" @input="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfNumberBox from "@/uni_modules/xtf-linkuiunix/components/xtf-number-box/xtf-number-box.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-number-box:input", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 disabled 状态 ​

运行时切换 disabled,观察组件对应状态变化。

vue
<template>
  <view class="doc-dynamic">
    <XtfNumberBox :value="2" :disabled="state" />
    <button class="doc-action-button" @click="toggleState">切换 disabled</button>
    <text class="doc-state-text">disabled: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfNumberBox from "@/uni_modules/xtf-linkuiunix/components/xtf-number-box/xtf-number-box.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", state.value) }
</script>

<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>

4. 调用 increase() ​

调用该公开实例能力;签名为 increase(): void。

vue
<template>
  <view class="doc-method">
    <XtfNumberBox :value="2" ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

<script setup lang="uts">
import XtfNumberBox from "@/uni_modules/xtf-linkuiunix/components/xtf-number-box/xtf-number-box.uvue"

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.increase(); console.log("调用 increase") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
valuenumber | string1参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 63、script 行 105需要覆盖组件默认业务值时设置。
modelValuenumber | string | nullnull参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 63、script 行 105需要覆盖组件默认业务值时设置。
minnumber | string0参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 41、script 行 107需要覆盖组件默认业务值时设置。
maxnumber | string9999参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 42、script 行 107需要覆盖组件默认业务值时设置。
stepnumber | string1参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 43、script 行 107需要覆盖组件默认业务值时设置。
disabledbooleanfalse参与组件运行逻辑;源码在 11 处读取该值;消费位置:script 行 67、script 行 68、script 行 71、script 行 91需要控制显示、可用性或交互状态时设置。
integerbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 45、script 行 107需要覆盖组件默认业务值时设置。
decimalLengthnumber | string-1参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46、script 行 107需要覆盖组件默认业务值时设置。
inputWidthnumber | string92设置对应区域宽度;消费位置:script 行 73需要调整布局或视觉表现时设置。
buttonSizenumber | string68设置对应元素尺寸;消费位置:script 行 73需要调整布局或视觉表现时设置。
theme"primary" | "success" | "warning" | "danger" | "info""primary"参与组件运行逻辑;源码在 1 处读取该值;可选值:primary / success / warning / danger / info;消费位置:script 行 71需要调整布局或视觉表现时设置。
showMinusbooleantrue开关对应显示或交互行为;消费位置:template 行 3需要控制显示、可用性或交互状态时设置。
showPlusbooleantrue开关对应显示或交互行为;消费位置:template 行 5需要控制显示、可用性或交互状态时设置。
showInputbooleantrue开关对应显示或交互行为;消费位置:template 行 4需要控制显示、可用性或交互状态时设置。
inputReadonlybooleanfalse参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 91、script 行 94、script 行 98、script 行 99需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 71需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 73需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
inputcommit 内触发(script 行 81);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:modelValuecommit 内触发(script 行 81);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:valuecommit 内触发(script 行 81);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changecommit 内触发(script 行 81);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
pluscommit 内触发(script 行 82);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
minuscommit 内触发(script 行 83);参数表达式:next(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
blurhandleBlur 内触发(script 行 99);参数表达式:value;前置 guard:props.disabled || props.inputReadonly(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
focushandleFocus 内触发(script 行 98);参数表达式:event;前置 guard:props.disabled || props.inputReadonly(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
confirmhandleConfirm 内触发(script 行 100);参数表达式:value;前置 guard:props.disabled || props.inputReadonly(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
overlimitdecrease 内触发(script 行 86);参数表达式:{ type: "minus", value: innerValue.value };前置 guard:minusDisabled.value
increase 内触发(script 行 87);参数表达式:{ type: "plus", value: innerValue.value };前置 guard:plusDisabled.value
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
--当前模板没有公开 slot。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
increaseincrease(): void调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。
decreasedecrease(): void调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。
focusfocus(): void调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。
blurblur(): void调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。
setValuesetValue(value: number): void调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。

公开状态 ​

状态类型 / 包装读取边界
--当前组件没有公开状态。

主题说明 ​

  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-danger-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-info-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-success-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-surface):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-warning-soft):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-number-box-button-size):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-number-box-color):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-number-box-input-width):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-number-box-soft):组件样式实际读取的主题变量,可在 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。

MIT Licensed