#
索引列表 IndexList

使用场景:地区选择、联系人列表

注意

使用该组件需开启微信开发者工具增强编译 (opens new window)选项

# 核心概念

因索引列表元素较多,为了便于你理解文档,我会简单介绍一下索引列表各个部分的名称

首先,我们把索引列表分为 4 个部分:AnchorContentSidebarTip

  • Anchor——锚点,指索引列表中每一小节的标题部分
  • Content——内容,指索引列表中每一小节的内容部分
  • Sidebar——侧栏,指位于屏幕右侧用于索引的导航条
  • Tip——提示,指滑动侧栏时,在屏幕上显示的提示

以上四个名词分别对应的部分如下图所示:

height=300

# 基本用法

索引列表由index-listindex-anchor构成,index-list需包裹在index-anchor的外层

<l-index-list scroll-top="{{scrollTop}}">
    <view>
        <l-index-anchor>A</l-index-anchor>
        <view>鞍山</view>
        <view>安庆</view>
        <view>安阳</view>
    </view>

    <view>
        <l-index-anchor>B</l-index-anchor>
        <view>鞍山</view>
        <view>安庆</view>
        <view>安阳</view>
    </view>
</l-index-list>
// 页面js文件
Page({
  data: {
    // 页面垂直滑动的距离
    scrollTop: undefined,
  },

  // 页面监听函数
  onPageScroll(res) {
    this.setData({
      scrollTop: res.scrollTop,
    })
  },
})

注意

页面js文件中必须使用 onPageScroll() (opens new window) 监听页面滚动事件,以便给scrollTop 属性传值。

# 高级用法

Sidebar显示的数据可通过属性sidebar-data自定义,否则显示为A-Z26 个大写英文字母。

Anchor显示内容可通过默认插槽自定义,否则显示为对应Sidebar的内容。

<!-- 使用 sidebar-data 自定义索引内容 -->
<l-index-list sidebar-data="{{sidebarData}}" bind:linselected="onSelected">

    <!-- 使用插槽自定义 Tip -->
    <view slot="tip">
      <view>{{indexText}}</view>
    </view>

    <view>
        <!-- 使用插槽自定义 Anchor -->
        <l-index-anchor>
          <view>热门</view>
        </l-index-anchor>

        <view>鞍山</view>
        <view>安庆</view>
        <view>安阳</view>
    </view>

    <view>
        <l-index-anchor>B</l-index-anchor>
        <view>鞍山</view>
        <view>安庆</view>
        <view>安阳</view>
    </view>
</l-index-list>
// 页面js文件
Page({

  data:{
    // 显示在 Tip 区域的文字
    indexText:""
  }

  // 页面监听函数
  onPageScroll(res) {
    wx.lin.setScrollTop(res.scrollTop)
  },

  // 索引被选中的监听函数
  onSelected(event){
    this.setData({
      indexText: event.detail.indexText
    })
  }
})

优化

scrollTop的传入方式除了使用index-list组件的属性传入以外,还支持wx.lin.setScrollTop(scrollTop)

如果对性能有极致要求,建议使用wx.lin.setScrollTop(scrollTop)的方式传入scrollTop属性。

# 索引列表属性(IndexList Arrtibutes)

参数 说明 类型 可选值 默认值 版本号
is-stick Anchor滚动到顶部时是否吸附 Boolean --- true ---
scroll-top onScrollTop监听函数获取到的值(单位px必填 Number --- ---
sidebar-data Sidebar显示的索引内容 String[] --- A-Z ---
show-sidebar 是否显示Sidebar Boolean --- true ---
stick-offset-top Anchor吸附时距离顶部的距离(单位rpx Number --- 0 ---

# 索引列表外部样式类(IndexList ExternalClasses)

外部样式类名 说明 备注 版本号
l-anchor-class 覆盖Anchor整体样式 --- ---
l-tip-class 覆盖Tip整体样式 --- ---
l-sidebar-class 覆盖Sidebar整体样式 --- ---
l-selected-class 覆盖Sidebar当前选择的索引项样式 --- ---
l-unselected-class 覆盖Sidebar未选择的索引项样式 --- ---

# 索引列表事件(IndexList Events)

事件名称 说明 返回值 备注 版本号
bind:linselected 索引选中回调事件 当前选中索引值 --- ---

# 索引列表插槽(IndexList Slot)

Slot 名称 说明 备注 版本号
默认 slot Content区域 --- ---
tip Tip区域 --- ---

# 索引锚点插槽(IndexAnchor Slot)

Slot 名称 说明 备注 版本号
默认 slot Anchor区域 --- ---

# 索引列表 wx.lin 方法(IndexList wx.lin Function)

方法名称 说明 返回值 备注 版本号
wx.lin.setScrollTop 设置scrollTop --- ---
    上次更新: 11/22/2020, 3:31:08 PM