Skip to content

xtf-tooltip ​

组件说明 ​

xtf-tooltip 是文字提示,用于围绕内容显示简短辅助说明。当前实现由 show 控制显示、通过 update:show 等事件反馈交互。

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

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfTooltip content="这里是组件内容" :show="true">
      <text class="doc-content-text">示例内容</text>
    </XtfTooltip>
  </view>
</template>

<script setup lang="uts">
import XtfTooltip from "@/uni_modules/xtf-linkuiunix/components/xtf-tooltip/xtf-tooltip.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">
    <XtfTooltip content="这里是组件内容" :show="true" @open="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfTooltip>
  </view>
</template>

<script setup lang="uts">
import XtfTooltip from "@/uni_modules/xtf-linkuiunix/components/xtf-tooltip/xtf-tooltip.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-tooltip:open", 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">
    <XtfTooltip content="这里是组件内容" :show="state">
      <text class="doc-content-text">示例内容</text>
    </XtfTooltip>
    <button class="doc-action-button" @click="toggleState">切换 show</button>
    <text class="doc-state-text">show: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfTooltip from "@/uni_modules/xtf-linkuiunix/components/xtf-tooltip/xtf-tooltip.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. 定制 default 插槽 ​

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

vue
<template>
  <view class="doc-slot">
    <XtfTooltip content="这里是组件内容" :show="true">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfTooltip>
  </view>
</template>

<script setup lang="uts">
import XtfTooltip from "@/uni_modules/xtf-linkuiunix/components/xtf-tooltip/xtf-tooltip.uvue"

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
showbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 7、script 行 10需要控制显示、可用性或交互状态时设置。
contentstring""兼容接收,当前实现未消费/不产生行为仅用于兼容现有调用;当前版本不应依赖其效果。
placementstring"bottom"兼容接收,当前实现未消费/不产生行为仅用于兼容现有调用;当前版本不应依赖其效果。
arrowbooleantrue兼容接收,当前实现未消费/不产生行为仅用于兼容现有调用;当前版本不应依赖其效果。
disabledbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 7需要控制显示、可用性或交互状态时设置。
closeOnClickOutsidebooleantrue兼容接收,当前实现未消费/不产生行为仅用于兼容现有调用;当前版本不应依赖其效果。

事件 ​

事件名称源码触发边界回调参数参数说明
update:showtoggle 内触发(script 行 7);参数表达式:!props.show
handleUpdate 内触发(script 行 8);参数表达式:value
(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
opensetup 内触发(script 行 10);参数表达式:无回调参数;条件分支:value(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
closesetup 内触发(script 行 10);参数表达式:无回调参数;条件分支:!(value)(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
default无 scope 参数仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
--当前组件没有公开实例方法。

公开状态 ​

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

主题说明 ​

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

平台与实现边界 ​

  • 基线为 HBuilderX 5.26+ 与 uni-app x;当前报告已验证 Web Chromium 的对应 Demo,不据此承诺 Safari、小程序或 App 原生端等价。
  • Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力,只有源码或完整性报告明确覆盖的部分才可视为已验证。
  • 本文按当前源码生成,不补入旧版 xtf-linkui 存在但迁移版未实现的 props、事件、slot 或方法。
  • 当前仅兼容接收、未发现运行消费的 props:content、placement、arrow、closeOnClickOutside。
  • 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。

MIT Licensed