xtf-index-bar

组件说明

xtf-index-bar 是索引栏，用于提供字母或分类索引导航。当前实现读取 indexList 数据、通过 select 等事件反馈交互、提供实例方法。

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

---

基础用法

1. 最小可用

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

<template>
  <view class="doc-minimum">
    <XtfIndexBar :index-list="fixture">
      <XtfIndexAnchor v-for="letter in fixture" :key="letter" :id="letter" :title="letter"><text class="doc-anchor-text">{{ letter }} 组联系人</text></XtfIndexAnchor>
    </XtfIndexBar>
  </view>
</template>

<script setup lang="uts">
import XtfIndexAnchor from "@/uni_modules/xtf-linkuiunix/components/xtf-index-anchor/xtf-index-anchor.uvue"
import XtfIndexBar from "@/uni_modules/xtf-linkuiunix/components/xtf-index-bar/xtf-index-bar.uvue"

const fixture = ['A', 'B', 'C'] as Array<string>
</script>

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

2. 核心数据与主要事件

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

<template>
  <view class="doc-core">
    <XtfIndexBar :index-list="fixture" @select="onPrimaryEvent">
      <XtfIndexAnchor v-for="letter in fixture" :key="letter" :id="letter" :title="letter"><text class="doc-anchor-text">{{ letter }} 组联系人</text></XtfIndexAnchor>
    </XtfIndexBar>
  </view>
</template>

<script setup lang="uts">
import XtfIndexAnchor from "@/uni_modules/xtf-linkuiunix/components/xtf-index-anchor/xtf-index-anchor.uvue"
import XtfIndexBar from "@/uni_modules/xtf-linkuiunix/components/xtf-index-bar/xtf-index-bar.uvue"

const fixture = ['A', 'B', 'C'] as Array<string>
function onPrimaryEvent(payload: any): void { console.log("xtf-index-bar:select", payload) }
</script>

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

3. 调用 scrollTo()

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

<template>
  <view class="doc-method">
    <XtfIndexBar :index-list="fixture" ref="componentRef">
      <XtfIndexAnchor v-for="letter in fixture" :key="letter" :id="letter" :title="letter"><text class="doc-anchor-text">{{ letter }} 组联系人</text></XtfIndexAnchor>
    </XtfIndexBar>
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

<script setup lang="uts">
import XtfIndexAnchor from "@/uni_modules/xtf-linkuiunix/components/xtf-index-anchor/xtf-index-anchor.uvue"
import XtfIndexBar from "@/uni_modules/xtf-linkuiunix/components/xtf-index-bar/xtf-index-bar.uvue"

import { ref } from "vue"
const fixture = ['A', 'B', 'C'] as Array<string>
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; }
.doc-anchor-text { padding: 18rpx 24rpx; color: #334155; font-size: 24rpx; }
</style>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
indexList	Array<any>	() => [] as Array<any>	提供组件渲染或选择使用的数据集合；消费位置：script 行 16、script 行 52	数据驱动或选项渲染场景。
height	string | number	"100%"	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 15	需要覆盖组件默认业务值时设置。
highlightColor	string	""	设置对应区域的颜色；消费位置：template 行 8	需要调整布局或视觉表现时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。
customStyle	any	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 15	需要调整布局或视觉表现时设置。
sidebarClass	string	""	追加到对应内部区域的 class；消费位置：template 行 6	需要调整布局或视觉表现时设置。
sidebarStyle	any	""	覆盖或追加对应内部区域的样式对象；消费位置：template 行 6	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
select	select 内触发（script 行 42）；参数表达式：{ index, name: label }；前置 guard：disposed || !isFinite(index) || Math.floor(index) != index || index < 0 || index >= resolvedIndexes.value.length、disposed || version != selectionVersion || scrollRef.value == null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
change	select 内触发（script 行 43）；参数表达式：{ index, name: label }；前置 guard：disposed || !isFinite(index) || Math.floor(index) != index || index < 0 || index >= resolvedIndexes.value.length、disposed || version != selectionVersion || scrollRef.value == null	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

插槽	Scope 参数	实际渲染位置
default	无 scope 参数	仅在模板对应 <slot> 渲染位置生效。

---

方法

实例方法

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

公开状态

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

---

主题说明

• var(--xtf-color-primary)：组件样式实际读取的主题变量，可在 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。