IndexBar 索引栏

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { IndexBar, IndexAnchor } from 'vant';
const app = createApp();
app.use(IndexBar);
app.use(IndexAnchor);

代码演示

基础用法

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

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

自定义索引列表

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

<van-index-bar :index-list="indexList">
  <van-index-anchor index="1">标题1</van-index-anchor>
  <van-cell title="文本" />
  <van-cell title="文本" />
  <van-cell title="文本" />
  <van-index-anchor index="2">标题2</van-index-anchor>
  <van-cell title="文本" />
  <van-cell title="文本" />
  <van-cell title="文本" />
  ...
</van-index-bar>

export default {
  setup() {
    return {
      indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
    };
  },
};

API

IndexBar Props

IndexAnchor Props

IndexBar Events

IndexBar 方法

通过 ref 可以获取到 IndexBar 实例并调用实例方法，详见组件实例方法。

类型定义

组件导出以下类型定义：

import type { IndexBarProps, IndexAnchorProps, IndexBarInstance } from 'vant';

IndexBarInstance 是组件实例的类型，用法如下：

import { ref } from 'vue';
import type { IndexBarInstance } from 'vant';
const indexBarRef = ref<IndexBarInstance>();
indexBarRef.value?.scrollTo('B');

IndexAnchor Slots

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。