Skip to content

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 默认值实际行为 / 范围适用范围
itemsany[]() => []参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 34、script 行 41、script 行 58、script 行 59数据驱动或选项渲染场景。
modelValuestring | numberundefined参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 44、script 行 125需要覆盖组件默认业务值时设置。
currentstring | number0提供当前受控状态;是否回写以事件表为准;消费位置:script 行 44、script 行 125需要覆盖组件默认业务值时设置。
currentItemIdstring''提供当前受控状态;是否回写以事件表为准;消费位置:script 行 40、script 行 41、script 行 125、script 行 126需要覆盖组件默认业务值时设置。
heightstring | number320参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 3需要覆盖组件默认业务值时设置。
autoplaybooleanfalse开关对应显示或交互行为;消费位置:template 行 4需要覆盖组件默认业务值时设置。
intervalnumber3000参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 4需要覆盖组件默认业务值时设置。
durationnumber320参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 48需要覆盖组件默认业务值时设置。
circularbooleantrue参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 37、script 行 58、script 行 127、template 行 5需要覆盖组件默认业务值时设置。
verticalbooleanfalse参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 74、script 行 82、script 行 114、template 行 5需要覆盖组件默认业务值时设置。
indicatorstring'dots'参与组件运行逻辑;源码在 5 处读取该值;消费位置:script 行 104、template 行 30、template 行 31、template 行 33需要覆盖组件默认业务值时设置。
indicatorPositionstring'center'参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 104、script 行 112、script 行 113需要覆盖组件默认业务值时设置。
previousMarginstring'0rpx'参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 6需要覆盖组件默认业务值时设置。
nextMarginstring'0rpx'参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 6需要覆盖组件默认业务值时设置。
displayMultipleItemsstring | number1提供组件渲染或选择使用的数据集合;消费位置:template 行 7数据驱动或选项渲染场景。
skipHiddenItemLayoutbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 7需要覆盖组件默认业务值时设置。
easingFunctionstring'default'参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
nativeIndicatorDotsbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 8需要覆盖组件默认业务值时设置。
indicatorColorstring'rgba(0,0,0,0.3)'设置对应区域的颜色;消费位置:template 行 8需要调整布局或视觉表现时设置。
indicatorActiveColorstring'#000000'设置对应区域的颜色;消费位置:template 行 9需要调整布局或视觉表现时设置。
disableTouchbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 9需要覆盖组件默认业务值时设置。
layoutstring'classic'参与组件运行逻辑;源码在 18 处读取该值;消费位置:script 行 49、script 行 50、script 行 53、script 行 54需要调整布局或视觉表现时设置。
animationstring'slide'参与组件运行逻辑;源码在 15 处读取该值;消费位置:script 行 47、script 行 79、script 行 80、script 行 81需要覆盖组件默认业务值时设置。
animationDurationstring | number420参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 90需要覆盖组件默认业务值时设置。
animationTimingFunctionstring'cubic-bezier(0.22,1,0.36,1)'参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 90需要覆盖组件默认业务值时设置。
nativeDurationstring | number320参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 48需要覆盖组件默认业务值时设置。
noAnimationbooleanfalse参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 47、template 行 13需要覆盖组件默认业务值时设置。
cardScalestring | number0.88参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 70需要覆盖组件默认业务值时设置。
sideOpacitystring | number0.54参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 88需要覆盖组件默认业务值时设置。
sideRotatestring | number10参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 71需要覆盖组件默认业务值时设置。
sideTranslatestring | number84参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 72需要覆盖组件默认业务值时设置。
captionVariantstring'auto'参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 103需要覆盖组件默认业务值时设置。
showOverlaybooleantrue开关对应显示或交互行为;消费位置:script 行 50需要控制显示、可用性或交互状态时设置。
itemRadiusstring | number28参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 95、template 行 3需要调整布局或视觉表现时设置。
itemShadowstring''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 98需要覆盖组件默认业务值时设置。
itemBackgroundstring''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 97需要覆盖组件默认业务值时设置。
itemPaddingstring | number''参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 96需要覆盖组件默认业务值时设置。
captionClassstring''追加到对应内部区域的 class;消费位置:template 行 20需要调整布局或视觉表现时设置。
captionStyleany''覆盖或追加对应内部区域的样式对象;消费位置:template 行 20需要调整布局或视觉表现时设置。
panelClassstring''追加到对应内部区域的 class;消费位置:template 行 3需要调整布局或视觉表现时设置。
panelStyleany''覆盖或追加对应内部区域的样式对象;消费位置:template 行 3需要调整布局或视觉表现时设置。
customAnimationClassstring''追加到对应内部区域的 class;消费位置:template 行 14需要调整布局或视觉表现时设置。
customAnimationStyleany''覆盖或追加对应内部区域的样式对象;消费位置:template 行 14需要调整布局或视觉表现时设置。
customClassstring''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。
customStyleany''参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
update:modelValuehandleChange 内触发(script 行 120);参数表达式:innerCurrent.value;前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current))(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:currenthandleChange 内触发(script 行 121);参数表达式:innerCurrent.value;前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current))(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
update:currentItemIdhandleChange 内触发(script 行 122);参数表达式:resolveId(props.items[innerCurrent.value], innerCurrent.value);前置 guard:props.items.length == 0 || !Number.isFinite(Number(event.detail.current))(...args: any[])表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。
changehandleChange 内触发(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。

MIT Licensed