Appearance
xtf-marquee
组件说明
xtf-marquee 是跑马灯,用于让超出容器的单行内容循环滚动。当前实现读取 items 数据、通过 click 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-marquee/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfMarquee label="保存" />
</view>
</template>
<script setup lang="uts">
import XtfMarquee from "@/uni_modules/xtf-linkuiunix/components/xtf-marquee/xtf-marquee.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfMarquee label="保存" :items="fixture" :clickable="true" @click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfMarquee from "@/uni_modules/xtf-linkuiunix/components/xtf-marquee/xtf-marquee.uvue"
const fixture = [{ text: '账单已同步', tag: '通知', meta: '刚刚' }, { text: '本月预算剩余 36%', tag: '预算', meta: '今日' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-marquee:click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 pauseOnPress 状态
运行时切换 pauseOnPress,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfMarquee label="保存" :pause-on-press="state" />
<button class="doc-action-button" @click="toggleState">切换 pauseOnPress</button>
<text class="doc-state-text">pauseOnPress: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfMarquee from "@/uni_modules/xtf-linkuiunix/components/xtf-marquee/xtf-marquee.uvue"
import { ref } from "vue"
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("pauseOnPress", 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>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
text | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 11 | 需要提供业务文案或图标内容时设置。 |
textColor | string | "" | 设置对应区域的颜色;消费位置:template 行 5、template 行 6 | 需要调整布局或视觉表现时设置。 |
items | Array<any> | () => [] as Array<any> | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 11 | 数据驱动或选项渲染场景。 |
speed | string | number | 48 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 65、script 行 94 | 需要覆盖组件默认业务值时设置。 |
direction | string | "left" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 14、script 行 69、script 行 94 | 需要覆盖组件默认业务值时设置。 |
gap | number | 48 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 94、template 行 6 | 需要覆盖组件默认业务值时设置。 |
pauseOnPress | boolean | true | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 7、script 行 15 | 需要覆盖组件默认业务值时设置。 |
pauseOnHover | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 7、script 行 16 | 需要覆盖组件默认业务值时设置。 |
barrage | boolean | false | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
variant | string | "default" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 48、template 行 2、template 行 6 | 需要调整布局或视觉表现时设置。 |
mode | string | "continuous" | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 39、script 行 48、script 行 94、template 行 2 | 需要覆盖组件默认业务值时设置。 |
duration | string | number | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 64、script 行 94 | 需要覆盖组件默认业务值时设置。 |
autoplay | boolean | true | 开关对应显示或交互行为;消费位置:script 行 7 | 需要覆盖组件默认业务值时设置。 |
rows | number | 1 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
vertical | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 14 | 需要覆盖组件默认业务值时设置。 |
rowGap | number | 16 | 兼容接收,当前实现未消费/不产生行为 | 仅用于兼容现有调用;当前版本不应依赖其效果。 |
itemHeight | number | 88 | 设置对应区域高度;消费位置:script 行 52、script 行 94、template 行 5、template 行 6 | 需要调整布局或视觉表现时设置。 |
icon | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 3 | 需要提供业务文案或图标内容时设置。 |
label | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 3 | 需要提供业务文案或图标内容时设置。 |
separator | string | "" | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 94、template 行 6 | 需要覆盖组件默认业务值时设置。 |
accentColor | string | "" | 设置对应区域的颜色;消费位置:template 行 3 | 需要调整布局或视觉表现时设置。 |
itemClass | string | "" | 追加到对应内部区域的 class;消费位置:script 行 94、template 行 6 | 需要调整布局或视觉表现时设置。 |
itemStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 94、template 行 6 | 需要调整布局或视觉表现时设置。 |
stepInterval | number | 2800 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 41、script 行 94 | 需要覆盖组件默认业务值时设置。 |
stepDuration | number | 420 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 53、script 行 94 | 需要覆盖组件默认业务值时设置。 |
clickable | boolean | false | 开关对应显示或交互行为;消费位置:script 行 17 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 94、template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 94、template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
click | 模板行 2 透传子组件事件;参数表达式:{ mode: props.mode, variant: props.variant, items: normalizedItems } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
item-click | itemClick 内触发(script 行 17);参数表达式:{ item, index, raw: item.raw } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | setup 内触发(script 行 47);参数表达式:{ index: stepIndex.value, item, raw: item.raw };前置 guard:!canPlay(version) || normalizedItems.value.length < 2 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
cycle-end | setup 内触发(script 行 48);参数表达式:{ mode: props.mode, variant: props.variant };前置 guard:!canPlay(version) || normalizedItems.value.length < 2 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
play-state-change | press 内触发(script 行 15);参数表达式:{ playing: !paused.value, paused: paused.value, reason: "press" };前置 guard:!props.pauseOnPresshover 内触发(script 行 16);参数表达式:{ playing: !paused.value, paused: paused.value, reason: "hover" };前置 guard:!props.pauseOnHover | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | 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:
barrage、rows、rowGap。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。