xtf-linkuiunix

Appearance

xtf-form-item ​

组件说明 ​

xtf-form-item 是表单项，用于连接字段标签、校验规则和输入控件。当前实现通过 validate-status-change 等事件反馈交互、提供实例方法。

  • 实际 Demo 路由：#/pages/components/xtf-form-item/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfFormItem label="保存">
      <text class="doc-content-text">示例内容</text>
    </XtfFormItem>
  </view>
</template>

<script setup lang="uts">
import XtfFormItem from "@/uni_modules/xtf-linkuiunix/components/xtf-form-item/xtf-form-item.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">
    <XtfFormItem label="保存" @validate-status-change="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfFormItem>
  </view>
</template>

<script setup lang="uts">
import XtfFormItem from "@/uni_modules/xtf-linkuiunix/components/xtf-form-item/xtf-form-item.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-form-item:validate-status-change", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

3. 动态 required 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfFormItem label="保存" :required="state">
      <text class="doc-content-text">示例内容</text>
    </XtfFormItem>
    <button class="doc-action-button" @click="toggleState">切换 required</button>
    <text class="doc-state-text">required: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfFormItem from "@/uni_modules/xtf-linkuiunix/components/xtf-form-item/xtf-form-item.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("required", 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. 定制 label 插槽 ​

使用源码真实声明的 label slot 替换对应内容。

vue
<template>
  <view class="doc-slot">
    <XtfFormItem label="保存">
      <template #label><text class="doc-content-text">自定义 label 内容</text></template>
    </XtfFormItem>
  </view>
</template>

<script setup lang="uts">
import XtfFormItem from "@/uni_modules/xtf-linkuiunix/components/xtf-form-item/xtf-form-item.uvue"

</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

5. 调用 validate() ​

校验全部字段；签名为 validate(trigger: string = ""): Promise<string>。

vue
<template>
  <view class="doc-method">
    <XtfFormItem label="保存" ref="componentRef">
      <text class="doc-content-text">示例内容</text>
    </XtfFormItem>
    <button class="doc-action-button" @click="callMethod">校验全部字段</button>
  </view>
</template>

<script setup lang="uts">
import XtfFormItem from "@/uni_modules/xtf-linkuiunix/components/xtf-form-item/xtf-form-item.uvue"

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.validate(); console.log("调用 validate") }
</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 默认值实际行为 / 范围适用范围
labelstring""参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 108、script 行 111、script 行 125、template 行 3需要提供业务文案或图标内容时设置。
propstring""参与组件运行逻辑；源码在 13 处读取该值；消费位置：script 行 17、script 行 18、script 行 41、script 行 42需要覆盖组件默认业务值时设置。
requiredbooleanfalse参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 19需要控制显示、可用性或交互状态时设置。
helpstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 11需要覆盖组件默认业务值时设置。
extrastring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 5需要覆盖组件默认业务值时设置。
errorstring""参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 25、script 行 26、script 行 121需要覆盖组件默认业务值时设置。
rulesArray<any>() => [] as Array<any>参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 18需要覆盖组件默认业务值时设置。
layoutstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 27需要调整布局或视觉表现时设置。
labelWidthstring | number""设置对应区域宽度；消费位置：script 行 34需要调整布局或视觉表现时设置。
sizestring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 28需要覆盖组件默认业务值时设置。
requiredMarkstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 20需要控制显示、可用性或交互状态时设置。
feedbackbooleanfalse参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 29需要覆盖组件默认业务值时设置。
validateTriggerstring | Array<any>""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 45需要覆盖组件默认业务值时设置。
linkagestring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 17需要覆盖组件默认业务值时设置。
dependenciesstring | Array<any>""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 17需要覆盖组件默认业务值时设置。
visibleWhenanyundefined参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 17需要覆盖组件默认业务值时设置。
disabledWhenanyundefined参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 17需要控制显示、可用性或交互状态时设置。
customClassstring""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 30需要调整布局或视觉表现时设置。
customStylestring | UTSJSONObject""参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
validate-status-changenotify 内触发（script 行 42）；参数表达式：payload；前置 guard：!mounted || !alive(...args: any[])表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
label无 scope 参数仅在模板对应 <slot> 渲染位置生效。
extra无 scope 参数仅在模板对应 <slot> 渲染位置生效。
default{ status, message, linkage-state, disabled, readonly, loading, triggerValidate, clearValidate }仅在模板对应 <slot> 渲染位置生效。
help无 scope 参数仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
validatevalidate(trigger: string = ""): Promise<string>校验全部字段；通过组件 ref 调用，参数和返回值按签名处理。
clearValidateclearValidate(): void清除校验结果；通过组件 ref 调用，参数和返回值按签名处理。
resetFieldresetField(): void调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。
scrollToFieldscrollToField(options: any = {}): void调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。

公开状态 ​

状态类型 / 包装读取边界
propprop: string (getter)通过组件 ref 读取；这是公开状态，不可作为函数调用。
labellabel: string (getter)通过组件 ref 读取；这是公开状态，不可作为函数调用。
resolvedMessageresolvedMessage: string (getter)通过组件 ref 读取；这是公开状态，不可作为函数调用。
validateStatusvalidateStatus: string (getter)通过组件 ref 读取；这是公开状态，不可作为函数调用。

主题说明 ​

  • 当前组件 CSS 未读取 var(--xtf-*) 主题变量；颜色或尺寸可能来自 props、固定样式或父级上下文。

平台与实现边界 ​

  • 基线为 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

Copyright © 2026 xtf-linkuiunix