Appearance
xtf-swiper
组件说明
xtf-swiper 是轮播,用于切换图片或自定义内容页。当前实现读取 items 数据、通过 update:modelValue 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-swiper/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfSwiper :items="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfSwiper from "@/uni_modules/xtf-linkuiunix/components/xtf-swiper/xtf-swiper.uvue"
const fixture = [{ key: 'one', image: '/static/logo.png', title: '账单概览' }, { key: 'two', image: '/static/logo.png', title: '支出趋势' }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfSwiper :items="fixture" @change="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfSwiper from "@/uni_modules/xtf-linkuiunix/components/xtf-swiper/xtf-swiper.uvue"
const fixture = [{ key: 'one', image: '/static/logo.png', title: '账单概览' }, { key: 'two', image: '/static/logo.png', title: '支出趋势' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-swiper:change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 autoplay 状态
运行时切换 autoplay,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfSwiper :items="fixture" :autoplay="state" />
<button class="doc-action-button" @click="toggleState">切换 autoplay</button>
<text class="doc-state-text">autoplay: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfSwiper from "@/uni_modules/xtf-linkuiunix/components/xtf-swiper/xtf-swiper.uvue"
import { ref } from "vue"
const fixture = [{ key: 'one', image: '/static/logo.png', title: '账单概览' }, { key: 'two', image: '/static/logo.png', title: '支出趋势' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("autoplay", 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>4. 定制 item 插槽
使用源码真实声明的 item slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfSwiper :items="fixture">
<template #item="scope"><text class="doc-content-text">自定义 item 内容:{{ scope.item }}</text></template>
</XtfSwiper>
</view>
</template>
<script setup lang="uts">
import XtfSwiper from "@/uni_modules/xtf-linkuiunix/components/xtf-swiper/xtf-swiper.uvue"
const fixture = [{ key: 'one', image: '/static/logo.png', title: '账单概览' }, { key: 'two', image: '/static/logo.png', title: '支出趋势' }] as Array<any>
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
items | any[] | () => [] | 参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 34、script 行 41、script 行 58、script 行 59 | 数据驱动或选项渲染场景。 |
modelValue | string | number | undefined | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 44、script 行 125 | 需要覆盖组件默认业务值时设置。 |
current | string | number | 0 | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 44、script 行 125 | 需要覆盖组件默认业务值时设置。 |
currentItemId | string | '' | 提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40、script 行 41、script 行 125、script 行 126 | 需要覆盖组件默认业务值时设置。 |
height | string | number | 320 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3 | 需要覆盖组件默认业务值时设置。 |
autoplay | boolean | false | 开关对应显示或交互行为;消费位置:template 行 4 | 需要覆盖组件默认业务值时设置。 |
interval | number | 3000 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 4 | 需要覆盖组件默认业务值时设置。 |
duration | number | 320 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 48 | 需要覆盖组件默认业务值时设置。 |
circular | boolean | true | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 37、script 行 58、script 行 127、template 行 5 | 需要覆盖组件默认业务值时设置。 |
vertical | boolean | false | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 74、script 行 82、script 行 114、template 行 5 | 需要覆盖组件默认业务值时设置。 |
indicator | string | 'dots' | 参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 104、template 行 30、template 行 31、template 行 33 | 需要覆盖组件默认业务值时设置。 |
indicatorPosition | string | 'center' | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 104、script 行 112、script 行 113 | 需要覆盖组件默认业务值时设置。 |
previousMargin | string | '0rpx' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 6 | 需要覆盖组件默认业务值时设置。 |
nextMargin | string | '0rpx' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 6 | 需要覆盖组件默认业务值时设置。 |
displayMultipleItems | string | number | 1 | 提供组件渲染或选择使用的数据集合;消费位置:template 行 7 | 数据驱动或选项渲染场景。 |
skipHiddenItemLayout | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 7 | 需要覆盖组件默认业务值时设置。 |
easingFunction | string | 'default' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
nativeIndicatorDots | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8 | 需要覆盖组件默认业务值时设置。 |
indicatorColor | string | 'rgba(0,0,0,0.3)' | 设置对应区域的颜色;消费位置:template 行 8 | 需要调整布局或视觉表现时设置。 |
indicatorActiveColor | string | '#000000' | 设置对应区域的颜色;消费位置:template 行 9 | 需要调整布局或视觉表现时设置。 |
disableTouch | boolean | false | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9 | 需要覆盖组件默认业务值时设置。 |
layout | string | 'classic' | 参与组件运行逻辑;源码在 18 处读取该值;消费位置:script 行 49、script 行 50、script 行 53、script 行 54 | 需要调整布局或视觉表现时设置。 |
animation | string | 'slide' | 参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 47、script 行 79、script 行 80、script 行 81 | 需要覆盖组件默认业务值时设置。 |
animationDuration | string | number | 420 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 90 | 需要覆盖组件默认业务值时设置。 |
animationTimingFunction | string | 'cubic-bezier(0.22,1,0.36,1)' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 90 | 需要覆盖组件默认业务值时设置。 |
nativeDuration | string | number | 320 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 48 | 需要覆盖组件默认业务值时设置。 |
noAnimation | boolean | false | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 47、template 行 13 | 需要覆盖组件默认业务值时设置。 |
cardScale | string | number | 0.88 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 70 | 需要覆盖组件默认业务值时设置。 |
sideOpacity | string | number | 0.54 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 88 | 需要覆盖组件默认业务值时设置。 |
sideRotate | string | number | 10 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 71 | 需要覆盖组件默认业务值时设置。 |
sideTranslate | string | number | 84 | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 72 | 需要覆盖组件默认业务值时设置。 |
captionVariant | string | 'auto' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 103 | 需要覆盖组件默认业务值时设置。 |
showOverlay | boolean | true | 开关对应显示或交互行为;消费位置:script 行 50 | 需要控制显示、可用性或交互状态时设置。 |
itemRadius | string | number | 28 | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95、template 行 3 | 需要调整布局或视觉表现时设置。 |
itemShadow | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 98 | 需要覆盖组件默认业务值时设置。 |
itemBackground | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 97 | 需要覆盖组件默认业务值时设置。 |
itemPadding | string | number | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 96 | 需要覆盖组件默认业务值时设置。 |
captionClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
captionStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 20 | 需要调整布局或视觉表现时设置。 |
panelClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 3 | 需要调整布局或视觉表现时设置。 |
panelStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 3 | 需要调整布局或视觉表现时设置。 |
customAnimationClass | string | '' | 追加到对应内部区域的 class;消费位置:template 行 14 | 需要调整布局或视觉表现时设置。 |
customAnimationStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:template 行 14 | 需要调整布局或视觉表现时设置。 |
customClass | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | any | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | handleChange 内触发(script 行 120);参数表达式:innerCurrent.value;前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current)) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:current | handleChange 内触发(script 行 121);参数表达式:innerCurrent.value;前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current)) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
update:currentItemId | handleChange 内触发(script 行 122);参数表达式:resolveId(props.items[innerCurrent.value], innerCurrent.value);前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current)) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | handleChange 内触发(script 行 123);参数表达式:innerCurrent.value;前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current)) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
animationfinish | 模板行 10 透传子组件事件;参数表达式:$event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
item-click | 模板行 14 透传子组件事件;参数表达式:{ item, index } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
image-error | 模板行 16 透传子组件事件;参数表达式:{ item, index } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
item | { item, index, active, state, layout, animation } | 仅在模板对应 <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 或方法。 - 详细公共边界见 平台与实现边界,逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。