xtf-linkuiunix

Appearance

xtf-motion ​

组件说明 ​

xtf-motion 是动效容器，用于对内容执行进入、退出和强调动画。当前实现通过 click 等事件反馈交互、提供实例方法。

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

基础用法 ​

1. 最小可用 ​

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

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

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

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

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

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

3. 动态 overlay 状态 ​

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

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

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

import { ref } from "vue"

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

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

</script>

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

5. 调用 play() ​

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

vue
<template>
  <view class="doc-method">
    <XtfMotion ref="componentRef">
      <text class="doc-content-text">示例内容</text>
    </XtfMotion>
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

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

import { ref } from "vue"

const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.play(); console.log("调用 play") }
</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 默认值实际行为 / 范围适用范围
effectstring"pulse-glow"参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 97需要覆盖组件默认业务值时设置。
effectsstring[] | string() => [] as string[]参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 90、script 行 91需要覆盖组件默认业务值时设置。
effectsMode"parallel" | "sequence""parallel"参与组件运行逻辑；源码在 3 处读取该值；可选值：parallel / sequence；消费位置：script 行 170、script 行 191、script 行 221需要覆盖组件默认业务值时设置。
effectsGapnumber | string120参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 105、script 行 221需要调整布局或视觉表现时设置。
themestring"primary"参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 112、script 行 113、script 行 114、script 行 115需要调整布局或视觉表现时设置。
accentColorstring""设置对应区域的颜色；消费位置：script 行 111需要调整布局或视觉表现时设置。
accentColor2string""参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 118需要覆盖组件默认业务值时设置。
durationnumber | string2200参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 103、script 行 221需要覆盖组件默认业务值时设置。
delaynumber | string0参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 104、script 行 221需要覆盖组件默认业务值时设置。
loopbooleantrue参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 170、script 行 194、script 行 211、script 行 221需要覆盖组件默认业务值时设置。
playbooleantrue参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 179、script 行 216、script 行 219需要覆盖组件默认业务值时设置。
pausedbooleanfalse参与组件运行逻辑；源码在 5 处读取该值；消费位置：script 行 188、script 行 195、script 行 202、script 行 216需要覆盖组件默认业务值时设置。
cascadebooleanfalse参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 158、script 行 170、script 行 183、script 行 221需要覆盖组件默认业务值时设置。
cascadeStepnumber | string120参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 185、script 行 221需要覆盖组件默认业务值时设置。
overlaybooleantrue参与组件运行逻辑；源码在 11 处读取该值；消费位置：script 行 121、script 行 122、script 行 123、script 行 124需要控制显示、可用性或交互状态时设置。
overlayLayerstring"below"参与组件运行逻辑；源码在 15 处读取该值；消费位置：script 行 137、script 行 143、script 行 144、script 行 145需要控制显示、可用性或交互状态时设置。
auraLayerstring"below"参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 137需要覆盖组件默认业务值时设置。
intensitynumber | string1参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 106需要覆盖组件默认业务值时设置。
radiusnumber | string28参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 107需要覆盖组件默认业务值时设置。
insetnumber | string10参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 108需要覆盖组件默认业务值时设置。
blockbooleanfalse参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 158需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 158需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 160需要调整布局或视觉表现时设置。

事件 ​

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

插槽 ​

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

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
playplay(): void调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。
pausepause(): void暂停执行；通过组件 ref 调用，参数和返回值按签名处理。
resumeresume(): void继续执行；通过组件 ref 调用，参数和返回值按签名处理。
cancelcancel(): void撤销当前草稿；通过组件 ref 调用，参数和返回值按签名处理。
resetreset(): void恢复初始状态；通过组件 ref 调用，参数和返回值按签名处理。

公开状态 ​

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

主题说明 ​

  • var(--xtf-motion-inset)：组件样式实际读取的主题变量，可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-motion-radius)：组件样式实际读取的主题变量，可在 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