Skip to content

xtf-timeline ​

组件说明 ​

xtf-timeline 是时间线,用于按时间顺序展示事件节点。当前实现读取 items 数据、通过 load-more 等事件反馈交互。

  • 实际 Demo 路由:#/pages/components/xtf-timeline/index
  • Demo 源码

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfTimeline :items="fixture" />
  </view>
</template>

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

const fixture = [{ title: '创建账单', time: '09:00' }, { title: '完成审核', time: '10:30' }] as Array<any>
</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件 ​

使用组件真实数据入口,并记录当前源码声明的主要事件。

vue
<template>
  <view class="doc-core">
    <XtfTimeline :items="fixture" @load-more="onPrimaryEvent" />
  </view>
</template>

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

const fixture = [{ title: '创建账单', time: '09:00' }, { title: '完成审核', time: '10:30' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-timeline:load-more", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 alternate 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfTimeline :items="fixture" :alternate="state" />
    <button class="doc-action-button" @click="toggleState">切换 alternate</button>
    <text class="doc-state-text">alternate: {{ state }}</text>
  </view>
</template>

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

import { ref } from "vue"
const fixture = [{ title: '创建账单', time: '09:00' }, { title: '完成审核', time: '10:30' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("alternate", 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 默认值实际行为 / 范围适用范围
itemsTimelineInput[]() => [] as TimelineInput[]参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 21数据驱动或选项渲染场景。
directionstring"vertical"参与组件运行逻辑;源码在 11 处读取该值;消费位置:script 行 23、script 行 24、script 行 25、script 行 26需要覆盖组件默认业务值时设置。
modestring"left"参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 22需要覆盖组件默认业务值时设置。
alternatebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 22需要覆盖组件默认业务值时设置。
lineStylestring"solid"覆盖或追加对应内部区域的样式对象;消费位置:script 行 26、template 行 10需要调整布局或视觉表现时设置。
loadMorebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 24需要覆盖组件默认业务值时设置。
pendingbooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 21需要覆盖组件默认业务值时设置。
pendingTextstring""设置对应区域的显示文案;消费位置:script 行 21需要提供业务文案或图标内容时设置。
reversebooleanfalse参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 21需要覆盖组件默认业务值时设置。
loadMoreTextstring""设置对应区域的显示文案;消费位置:script 行 29需要提供业务文案或图标内容时设置。
customClassstring""参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 23需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2需要调整布局或视觉表现时设置。

事件 ​

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

插槽 ​

插槽Scope 参数实际渲染位置
--当前模板没有公开 slot。

方法 ​

实例方法 ​

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

公开状态 ​

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

主题说明 ​

  • var(--xtf-color-border):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-primary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-timeline-gradient-line-horizontal):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-timeline-gradient-line-vertical):组件样式实际读取的主题变量,可在 xtf-config-provider 作用域或主题 class 下覆盖。
  • var(--xtf-timeline-node-color):组件样式实际读取的主题变量,可在 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