vant-weapp/packages/index-bar

IndexBar 索引栏

介绍

用于列表的索引分类显示和快速定位。

引入

在app.json或index.json中引入组件，详细介绍见快速上手。

"usingComponents": {
  "van-index-bar": "@vant/weapp/index-bar/index",
  "van-index-anchor": "@vant/weapp/index-anchor/index"
}

Vant Weapp 1.0 版本开始支持此组件，升级方式参见快速上手

代码演示

基础用法

点击索引栏时，会自动跳转到对应的IndexAnchor锚点位置。

<van-index-bar>
  <view>
    <van-index-anchor index="A" />
    <van-cell title="文本" />
    <van-cell title="文本" />
    <van-cell title="文本" />
  </view>

  <view>
    <van-index-anchor index="B" />
    <van-cell title="文本" />
    <van-cell title="文本" />
    <van-cell title="文本" />
  </view>

  ...
</van-index-bar>

自定义索引列表

可以通过index-list属性自定义展示的索引字符列表。

<van-index-bar index-list="{{ indexList }}">
  <view>
    <van-index-anchor index="1">标题1</van-index-anchor>
    <van-cell title="文本" />
    <van-cell title="文本" />
    <van-cell title="文本" />
  </view>

  <view>
    <van-index-anchor index="2">标题2</van-index-anchor>
    <van-cell title="文本" />
    <van-cell title="文本" />
    <van-cell title="文本" />
  </view>

  ...
</van-index-bar>

Page({
  data: {
    indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
  },
});

API

IndexBar Props

参数	说明	类型	默认值	版本
index-list	索引字符列表	string[] | number[]	A-Z	-
z-index	z-index 层级	number	1	-
sticky	是否开启锚点自动吸顶	boolean	true	-
sticky-offset-top	锚点自动吸顶时与顶部的距离	number	0	-
highlight-color	索引字符高亮颜色	string	#07c160	-

IndexAnchor Props

参数	说明	类型	默认值	版本
use-slot	是否使用自定义内容的插槽	boolean	false	-
index	索引字符	string | number	-	-

IndexBar Events

事件名	说明	回调参数
select	选中字符时触发	index: 索引字符

IndexAnchor Slots

名称	说明
-	锚点位置显示内容，默认为索引字符

常见问题

嵌套在滚动元素中 IndexAnchor 失效？

由于 <IndexBar /> 内部使用 wx.pageScrollTo 滚动到指定位置，因此只支持页面级滚动，无法在滚动元素中嵌套使用，例如：view 使用 overflow: scroll; 或者 scroll-view，具体可查看微信小程序文档。历史 issue: #4252