xtf-linkuiunix

Appearance

xtf-back-top ​

组件说明 ​

xtf-back-top 是返回顶部，用于在滚动内容达到阈值后提供快速回顶入口。当前实现通过 click 等事件反馈交互。

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

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfBackTop text="示例内容">
      <text class="doc-content-text">示例内容</text>
    </XtfBackTop>
  </view>
</template>

<script setup lang="uts">
import XtfBackTop from "@/uni_modules/xtf-linkuiunix/components/xtf-back-top/xtf-back-top.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">
    <XtfBackTop text="示例内容" @click="onPrimaryEvent">
      <text class="doc-content-text">示例内容</text>
    </XtfBackTop>
  </view>
</template>

<script setup lang="uts">
import XtfBackTop from "@/uni_modules/xtf-linkuiunix/components/xtf-back-top/xtf-back-top.uvue"

function onPrimaryEvent(payload: any): void { console.log("xtf-back-top:click", payload) }
</script>

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

3. 动态 showProgress 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfBackTop text="示例内容" :show-progress="state">
      <text class="doc-content-text">示例内容</text>
    </XtfBackTop>
    <button class="doc-action-button" @click="toggleState">切换 showProgress</button>
    <text class="doc-state-text">showProgress: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfBackTop from "@/uni_modules/xtf-linkuiunix/components/xtf-back-top/xtf-back-top.uvue"

import { ref } from "vue"

const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("showProgress", 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">
    <XtfBackTop text="示例内容">
      <template #default><text class="doc-content-text">自定义 default 内容</text></template>
    </XtfBackTop>
  </view>
</template>

<script setup lang="uts">
import XtfBackTop from "@/uni_modules/xtf-linkuiunix/components/xtf-back-top/xtf-back-top.uvue"

</script>

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

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
scrollTopnumber0参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 73需要覆盖组件默认业务值时设置。
thresholdnumber400参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 73需要覆盖组件默认业务值时设置。
targetstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 132、script 行 134需要覆盖组件默认业务值时设置。
rightnumber28参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 104需要覆盖组件默认业务值时设置。
bottomnumber120参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 105需要覆盖组件默认业务值时设置。
durationnumber320参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 137需要覆盖组件默认业务值时设置。
iconstring"north"参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 5需要提供业务文案或图标内容时设置。
textstring""参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 74、template 行 7需要提供业务文案或图标内容时设置。
variantXtfBackTopVariant"solid"参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 83、script 行 84、script 行 99需要调整布局或视觉表现时设置。
sizeXtfBackTopSize"md"参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 77、script 行 78、script 行 99需要覆盖组件默认业务值时设置。
shapeXtfBackTopShape"round"参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 99需要覆盖组件默认业务值时设置。
imagestring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 4需要覆盖组件默认业务值时设置。
imageModestring"aspectFit"参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 4需要覆盖组件默认业务值时设置。
imageSizenumber0设置对应元素尺寸；消费位置：script 行 122需要调整布局或视觉表现时设置。
imageRadiusnumber0参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 127需要调整布局或视觉表现时设置。
iconSizenumber0设置对应元素尺寸；消费位置：script 行 76需要调整布局或视觉表现时设置。
iconColorstring""设置对应区域的颜色；消费位置：script 行 82需要调整布局或视觉表现时设置。
textColorstring""设置对应区域的颜色；消费位置：script 行 88需要调整布局或视觉表现时设置。
showProgressbooleanfalse开关对应显示或交互行为；消费位置：template 行 6需要控制显示、可用性或交互状态时设置。
progressnumber0参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 92、script 行 93、script 行 94需要覆盖组件默认业务值时设置。
progressColorstring""设置对应区域的颜色；消费位置：script 行 120需要调整布局或视觉表现时设置。
contentDirectionXtfBackTopDirection"column"参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 101、script 行 113、script 行 116、script 行 117需要覆盖组件默认业务值时设置。
backgroundColorstring""设置对应区域的颜色；消费位置：script 行 107需要调整布局或视觉表现时设置。
borderColorstring""设置对应区域的颜色；消费位置：script 行 108需要调整布局或视觉表现时设置。
shadowstring""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 109需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 99需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2需要调整布局或视觉表现时设置。

事件 ​

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

插槽 ​

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

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-color-border)：组件样式实际读取的主题变量，可在 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 下覆盖。

平台与实现边界 ​

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