Appearance
xtf-password-input
组件说明
xtf-password-input 是密码输入,用于展示定长密码或验证码输入状态。当前实现通过 update:value 等事件反馈交互、提供实例方法。
- 实际 Demo 路由:
#/pages/components/xtf-password-input/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfPasswordInput value="123" />
</view>
</template>
<script setup lang="uts">
import XtfPasswordInput from "@/uni_modules/xtf-linkuiunix/components/xtf-password-input/xtf-password-input.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfPasswordInput value="123" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfPasswordInput from "@/uni_modules/xtf-linkuiunix/components/xtf-password-input/xtf-password-input.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-password-input:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfPasswordInput value="123" :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 XtfPasswordInput from "@/uni_modules/xtf-linkuiunix/components/xtf-password-input/xtf-password-input.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. 调用 focus()
调用该公开实例能力;签名为 focus(): void。
vue
<template>
<view class="doc-method">
<XtfPasswordInput value="123" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfPasswordInput from "@/uni_modules/xtf-linkuiunix/components/xtf-password-input/xtf-password-input.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.focus(); console.log("调用 focus") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
value | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 6 | 需要覆盖组件默认业务值时设置。 |
modelValue | string | undefined | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 6 | 需要覆盖组件默认业务值时设置。 |
length | string | number | 6 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 7 | 需要覆盖组件默认业务值时设置。 |
mask | boolean | true | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:template 行 4、template 行 6 | 需要覆盖组件默认业务值时设置。 |
gutter | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 12 | 需要覆盖组件默认业务值时设置。 |
focused | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 5、script 行 9 | 需要覆盖组件默认业务值时设置。 |
errorInfo | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 13、template 行 7 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑;源码在 9 处读取该值;消费位置:script 行 5、script 行 9、script 行 10、script 行 14 | 需要控制显示、可用性或交互状态时设置。 |
readonly | boolean | false | 参与组件运行逻辑;源码在 8 处读取该值;消费位置:script 行 5、script 行 9、script 行 10、script 行 14 | 需要控制显示、可用性或交互状态时设置。 |
size | string | "md" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 12 | 需要覆盖组件默认业务值时设置。 |
variant | string | "outline" | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 13、template 行 2、template 行 4 | 需要调整布局或视觉表现时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:value | handleInput 内触发(script 行 14);参数表达式:value;前置 guard:props.disabled || props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | handleInput 内触发(script 行 14);参数表达式:value;前置 guard:props.disabled || props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
input | handleInput 内触发(script 行 14);参数表达式:value;前置 guard:props.disabled || props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
focus | handleFocus 内触发(script 行 16);参数表达式:无回调参数;前置 guard:props.disabled || props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
blur | handleBlur 内触发(script 行 17);参数表达式:无回调参数 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
complete | setup 内触发(script 行 11);参数表达式:currentValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
focus | focus(): void | 调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。 |
blur | blur(): void | 调用该公开实例能力;通过组件 ref 调用,参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text):组件样式实际读取的主题变量,可在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。