xtf-linkuiunix

Appearance

xtf-index-list ​

组件说明 ​

xtf-index-list 是索引列表，用于按分组数据渲染可索引内容。当前实现读取 dataSource 数据、通过 item-click 等事件反馈交互、提供实例方法。

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

基础用法 ​

1. 最小可用 ​

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

vue
<template>
  <view class="doc-minimum">
    <XtfIndexList :data-source="fixture" height="600rpx" />
  </view>
</template>

<script setup lang="uts">
import XtfIndexList from "@/uni_modules/xtf-linkuiunix/components/xtf-index-list/xtf-index-list.uvue"

const fixture = [{ name: 'A', items: [{ name: '安阳', desc: '河南' }] }, { name: 'B', items: [{ name: '北京', desc: '直辖市' }] }] as Array<any>
</script>

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

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

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

vue
<template>
  <view class="doc-core">
    <XtfIndexList :data-source="fixture" height="600rpx" :clickable="true" @item-click="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfIndexList from "@/uni_modules/xtf-linkuiunix/components/xtf-index-list/xtf-index-list.uvue"

const fixture = [{ name: 'A', items: [{ name: '安阳', desc: '河南' }] }, { name: 'B', items: [{ name: '北京', desc: '直辖市' }] }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-index-list:item-click", payload) }
</script>

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

3. 动态 clickable 状态 ​

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

vue
<template>
  <view class="doc-dynamic">
    <XtfIndexList :data-source="fixture" height="600rpx" :clickable="state" />
    <button class="doc-action-button" @click="toggleState">切换 clickable</button>
    <text class="doc-state-text">clickable: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfIndexList from "@/uni_modules/xtf-linkuiunix/components/xtf-index-list/xtf-index-list.uvue"

import { ref } from "vue"
const fixture = [{ name: 'A', items: [{ name: '安阳', desc: '河南' }] }, { name: 'B', items: [{ name: '北京', desc: '直辖市' }] }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("clickable", 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">
    <XtfIndexList :data-source="fixture" height="600rpx">
      <template #item="scope"><text class="doc-content-text">自定义 item 内容：{{ scope.key }}</text></template>
    </XtfIndexList>
  </view>
</template>

<script setup lang="uts">
import XtfIndexList from "@/uni_modules/xtf-linkuiunix/components/xtf-index-list/xtf-index-list.uvue"

const fixture = [{ name: 'A', items: [{ name: '安阳', desc: '河南' }] }, { name: 'B', items: [{ name: '北京', desc: '直辖市' }] }] as Array<any>
</script>

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

5. 调用 scrollTo() ​

调用该公开实例能力；签名为 scrollTo(index: string | number): void。

vue
<template>
  <view class="doc-method">
    <XtfIndexList :data-source="fixture" height="600rpx" ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

<script setup lang="uts">
import XtfIndexList from "@/uni_modules/xtf-linkuiunix/components/xtf-index-list/xtf-index-list.uvue"

import { ref } from "vue"
const fixture = [{ name: 'A', items: [{ name: '安阳', desc: '河南' }] }, { name: 'B', items: [{ name: '北京', desc: '直辖市' }] }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.scrollTo(0); console.log("调用 scrollTo") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

全部属性 ​

属性源码类型withDefaults 默认值实际行为 / 范围适用范围
dataSourceArray<any>() => [] as Array<any>参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 9、script 行 18、template 行 4需要覆盖组件默认业务值时设置。
indexListArray<any>() => [] as Array<any>提供组件渲染或选择使用的数据集合；消费位置：script 行 9数据驱动或选项渲染场景。
heightstring | number"100%"参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3需要覆盖组件默认业务值时设置。
highlightColorstring""设置对应区域的颜色；消费位置：template 行 3需要调整布局或视觉表现时设置。
clickablebooleanfalse开关对应显示或交互行为；消费位置：script 行 18、template 行 8需要覆盖组件默认业务值时设置。
fieldNamesany() => ({ group: "name", title: "name", desc: "desc", icon: "icon", thumb: "thumb" })参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 10需要覆盖组件默认业务值时设置。
customClassstring""参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2需要调整布局或视觉表现时设置。
customStyleUTSJSONObject() => ({} as UTSJSONObject)参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2需要调整布局或视觉表现时设置。

事件 ​

事件名称源码触发边界回调参数参数说明
item-clickclickItem 内触发（script 行 18）；参数表达式：payload；前置 guard：!props.clickable(...args: any[])表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
selectclickItem 内触发（script 行 18）；参数表达式：payload；前置 guard：!props.clickable(...args: any[])表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
index-selectforwardIndex 内触发（script 行 19）；参数表达式：payload(...args: any[])表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

插槽 ​

插槽Scope 参数实际渲染位置
item{ key, group, item, index }仅在模板对应 <slot> 渲染位置生效。

方法 ​

实例方法 ​

方法签名 / 返回值调用边界
scrollToscrollTo(index: string | number): void调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。

公开状态 ​

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

主题说明 ​

  • 当前组件 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

Copyright © 2026 xtf-linkuiunix