IndexBar 索引栏

引入

  1. import { createApp } from 'vue';
  2. import { IndexBar, IndexAnchor } from 'vant';
  3. const app = createApp();
  4. app.use(IndexBar);
  5. app.use(IndexAnchor);

代码演示

基础用法

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

  1. <van-index-bar>
  2. <van-index-anchor index="A" />
  3. <van-cell title="文本" />
  4. <van-cell title="文本" />
  5. <van-cell title="文本" />
  6. <van-index-anchor index="B" />
  7. <van-cell title="文本" />
  8. <van-cell title="文本" />
  9. <van-cell title="文本" />
  10. ...
  11. </van-index-bar>

自定义索引列表

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

  1. <van-index-bar :index-list="indexList">
  2. <van-index-anchor index="1">标题1</van-index-anchor>
  3. <van-cell title="文本" />
  4. <van-cell title="文本" />
  5. <van-cell title="文本" />
  6. <van-index-anchor index="2">标题2</van-index-anchor>
  7. <van-cell title="文本" />
  8. <van-cell title="文本" />
  9. <van-cell title="文本" />
  10. ...
  11. </van-index-bar>
  1. export default {
  2. data() {
  3. return {
  4. indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
  5. };
  6. },
  7. };

API

IndexBar Props

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

IndexAnchor Props

参数说明类型默认值
index索引字符number | string-

IndexBar Events

事件名说明回调参数
select点击索引栏的字符时触发index: number | string
change v2.10.10当前高亮的索引字符变化时触发index: number | string

IndexAnchor Slots

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

样式变量

组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考主题定制

名称默认值描述
@index-bar-sidebar-z-index2-
@index-bar-index-font-size@font-size-xs-
@index-bar-index-line-height@line-height-xs-
@index-bar-index-active-color@red-
@index-anchor-z-index1-
@index-anchor-padding0 @padding-md-
@index-anchor-text-color@text-color-
@index-anchor-font-weight@font-weight-bold-
@index-anchor-font-size@font-size-md-
@index-anchor-line-height32px-
@index-anchor-background-colortransparent-
@index-anchor-sticky-text-color@red-
@index-anchor-sticky-background-color@white-

IndexBar 索引栏 - 图1