Vant4 IndexBar 索引欄

介紹

用于列表的索引分類(lèi)顯示和快速定位。

引入

通過(guò)以下方式來(lái)全局注冊(cè)組件，更多注冊(cè)方式請(qǐng)參考組件注冊(cè)。

import { createApp } from 'vue';
import { IndexBar, IndexAnchor } from 'vant';

const app = createApp();
app.use(IndexBar);
app.use(IndexAnchor);

代碼演示

基礎(chǔ)用法

點(diǎn)擊索引欄時(shí)，會(huì)自動(dòng)跳轉(zhuǎn)到對(duì)應(yīng)的 ?IndexAnchor? 錨點(diǎn)位置。

<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>

自定義索引列表

可以通過(guò) ?index-list? 屬性自定義展示的索引字符列表。

<van-index-bar :index-list="indexList">
  <van-index-anchor index="1">標(biāo)題1</van-index-anchor>
  <van-cell title="文本" />
  <van-cell title="文本" />
  <van-cell title="文本" />

  <van-index-anchor index="2">標(biāo)題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 方法

通過(guò) ref 可以獲取到 IndexBar 實(shí)例并調(diào)用實(shí)例方法，詳見(jiàn)組件實(shí)例方法。

類(lèi)型定義

組件導(dǎo)出以下類(lèi)型定義：

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

?IndexBarInstance? 是組件實(shí)例的類(lèi)型，用法如下：

import { ref } from 'vue';
import type { IndexBarInstance } from 'vant';

const indexBarRef = ref<IndexBarInstance>();

indexBarRef.value?.scrollTo('B');

IndexAnchor Slots

主題定制

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請(qǐng)參考 ConfigProvider 組件。