Vant3 IndexBar 索引欄

2021-09-14 11:09 更新

介紹

用于列表的索引分類顯示和快速定位。

實(shí)例演示

引入

通過以下方式來全局注冊組件,更多注冊方式請參考組件注冊。

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

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

代碼演示

基礎(chǔ)用法

點(diǎn)擊索引欄時,會自動跳轉(zhuǎn)到對應(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>

自定義索引列表

可以通過 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

參數(shù) 說明 類型 默認(rèn)值
index-list 索引字符列表 string[] | number[] A-Z
z-index z-index 層級 number | string 1
sticky 是否開啟錨點(diǎn)自動吸頂 boolean true
sticky-offset-top 錨點(diǎn)自動吸頂時與頂部的距離 number 0
highlight-color 索引字符高亮顏色 string #ee0a24
teleport v3.0.19 指定索引欄掛載的節(jié)點(diǎn) string | Element -

IndexAnchor Props

參數(shù) 說明 類型 默認(rèn)值
index 索引字符 number | string -

IndexBar Events

事件名 說明 回調(diào)參數(shù)
select 點(diǎn)擊索引欄的字符時觸發(fā) index: number | string
change 當(dāng)前高亮的索引字符變化時觸發(fā) index: number | string

IndexBar 方法

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

方法名 說明 參數(shù) 返回值
scrollTo 滾動到指定錨點(diǎn) index: number | string -

IndexAnchor Slots

名稱 說明
default 錨點(diǎn)位置顯示內(nèi)容,默認(rèn)為索引字符

樣式變量

組件提供了下列 CSS 變量,可用于自定義樣式,使用方法請參考ConfigProvider 組件。

名稱 默認(rèn)值 描述
--van-index-bar-sidebar-z-index 2 -
--van-index-bar-index-font-size var(--van-font-size-xs) -
--van-index-bar-index-line-height var(--van-line-height-xs) -
--van-index-bar-index-active-color var(--van-danger-color) -
--van-index-anchor-z-index 1 -
--van-index-anchor-padding 0 var(--van-padding-md) -
--van-index-anchor-text-color var(--van-text-color) -
--van-index-anchor-font-weight var(--van-font-weight-bold) -
--van-index-anchor-font-size var(--van-font-size-md) -
--van-index-anchor-line-height 32px -
--van-index-anchor-background-color transparent -
--van-index-anchor-sticky-text-color var(--van-danger-color) -
--van-index-anchor-sticky-background-color var(--van-white) -


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號