mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-05-03 14:46:34 +08:00
117 lines
3.1 KiB
Markdown
117 lines
3.1 KiB
Markdown
# IndexBar 索引栏
|
||
|
||
### 介绍
|
||
|
||
用于列表的索引分类显示和快速定位。
|
||
|
||
### 引入
|
||
|
||
在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"van-index-bar": "@vant/weapp/index-bar/index",
|
||
"van-index-anchor": "@vant/weapp/index-anchor/index"
|
||
}
|
||
```
|
||
|
||
> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)
|
||
|
||
## 代码演示
|
||
|
||
### 基础用法
|
||
|
||
点击索引栏时，会自动跳转到对应的`IndexAnchor`锚点位置。
|
||
|
||
```html
|
||
<van-index-bar>
|
||
<view>
|
||
<van-index-anchor index="A" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
</view>
|
||
|
||
<view>
|
||
<van-index-anchor index="B" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
</view>
|
||
|
||
...
|
||
</van-index-bar>
|
||
```
|
||
|
||
### 自定义索引列表
|
||
|
||
可以通过`index-list`属性自定义展示的索引字符列表。
|
||
|
||
```html
|
||
<van-index-bar index-list="{{ indexList }}">
|
||
<view>
|
||
<van-index-anchor index="1">标题1</van-index-anchor>
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
</view>
|
||
|
||
<view>
|
||
<van-index-anchor index="2">标题2</van-index-anchor>
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
<van-cell title="文本" />
|
||
</view>
|
||
|
||
...
|
||
</van-index-bar>
|
||
```
|
||
|
||
```javascript
|
||
Page({
|
||
data: {
|
||
indexList: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
|
||
},
|
||
});
|
||
```
|
||
|
||
## API
|
||
|
||
### IndexBar Props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| index-list | 索引字符列表 | _string[] \| number[]_ | `A-Z` | - |
|
||
| z-index | z-index 层级 | _number_ | `1` | - |
|
||
| sticky | 是否开启锚点自动吸顶 | _boolean_ | `true` | - |
|
||
| sticky-offset-top | 锚点自动吸顶时与顶部的距离 | _number_ | `0` | - |
|
||
| highlight-color | 索引字符高亮颜色 | _string_ | `#07c160` | - |
|
||
|
||
### IndexAnchor Props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| -------- | ------------------------ | ------------------ | ------- | ---- |
|
||
| use-slot | 是否使用自定义内容的插槽 | _boolean_ | `false` | - |
|
||
| index | 索引字符 | _string \| number_ | - | - |
|
||
|
||
### IndexBar Events
|
||
|
||
| 事件名 | 说明 | 回调参数 |
|
||
| ------ | -------------- | --------------- |
|
||
| select | 选中字符时触发 | index: 索引字符 |
|
||
|
||
### IndexAnchor Slots
|
||
|
||
| 名称 | 说明 |
|
||
| ---- | -------------------------------- |
|
||
| - | 锚点位置显示内容，默认为索引字符 |
|
||
|
||
|
||
## 常见问题
|
||
|
||
### 嵌套在滚动元素中 IndexAnchor 失效？
|
||
|
||
由于 `<IndexBar />` 内部使用 wx.pageScrollTo 滚动到指定位置，因此只支持页面级滚动，无法在滚动元素中嵌套使用，例如：`view` 使用 `overflow: scroll;` 或者 `scroll-view`，
|
||
具体可查看[微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.html)。
|
||
历史issue: [#4252](https://github.com/youzan/vant-weapp/issues/4252)
|