IndexBar 索引栏

引入

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

基础用法

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

  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. </van-index-bar>
  1. export default {
  2. setup() {
  3. return {
  4. indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
  5. };
  6. },
  7. };

IndexBar Props

IndexAnchor Props

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

IndexBar 方法

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

方法名说明参数返回值
scrollTo滚动到指定锚点index: number | string-

类型定义

组件导出以下类型定义:

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

样式变量

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

名称默认值描述
—van-index-bar-sidebar-z-index2-
—van-index-bar-index-font-sizevar(—van-font-size-xs)-
—van-index-bar-index-line-heightvar(—van-line-height-xs)-
—van-index-bar-index-active-colorvar(—van-danger-color)-
—van-index-anchor-z-index1-
—van-index-anchor-padding0 var(—van-padding-md)-
—van-index-anchor-text-colorvar(—van-text-color)-
—van-index-anchor-font-weightvar(—van-font-weight-bold)-
—van-index-anchor-font-sizevar(—van-font-size-md)-
—van-index-anchor-line-height32px-
—van-index-anchor-background-colortransparent-
—van-index-anchor-sticky-text-colorvar(—van-danger-color)-
—van-index-anchor-sticky-background-colorvar(—van-white)-