list-view

组件类型：UniListViewElement

列表组件

兼容性

Web	Android	iOS
4.02	3.9	4.11

在App中，基于recycle-view的list，才能实现长列表的资源自动回收，以保障列表加载很多项目时，屏幕外的资源被有效回收。list-view就是基于recycle-view的list组件。

每个list由1个父组件list-view及若干子组件list-item构成。仅有有限子组件可识别，见下

list-view和scroll-view都是滚动组件，list适用于长列表场景，其他场景适用于scroll-view。

list-view支持通过子组件sticky-header处理吸顶的场景。

属性

名称	类型	默认值	兼容性	描述
direction	string	"vertical"	Web Android iOS x 4.0 4.11	滚动方向，可取值 none、horizontal、vertical，默认值vertical。注：iOS 平台仅支持vertical
合法值 兼容性 描述 none Web Android iOS 4.02 4.0 4.11 禁止滚动 horizontal Web Android iOS x 4.0 x 横向滚动 vertical Web Android iOS 4.02 4.0 4.11 竖向滚动
associative-container	string	""	Web Android iOS x 4.11 4.11	关联的滚动容器
合法值 兼容性 描述 nested-scroll-view Web Android iOS x 4.11 4.11 嵌套滚动
bounces	boolean	true	Web Android iOS x 4.0 4.11	控制是否回弹效果 优先级高于rebound
upper-threshold	number	50	Web Android iOS 4.02 3.9 4.11	距顶部/左边多远时（单位px），触发 scrolltoupper 事件
lower-threshold	number	50	Web Android iOS 4.02 3.9 4.11	距底部/右边多远时（单位px），触发 scrolltolower 事件
scroll-top	number	0	Web Android iOS 4.02 3.9 4.11	设置竖向滚动条位置
scroll-left	number	0	Web Android iOS x 3.9 4.11	设置横向滚动条位置
show-scrollbar	boolean	true	Web Android iOS 4.02 3.9 4.11	控制是否出现滚动条
scroll-into-view	string(string.IDString)	-	Web Android iOS x 3.9 4.11	值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素起始位置
scroll-with-animation	boolean	false	Web Android iOS 4.02 3.9 4.11	是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画
refresher-enabled	boolean	false	Web Android iOS 4.11 3.9 4.11	开启下拉刷新，暂时不支持scroll-x = true横向刷新
refresher-threshold	number	45	Web Android iOS 4.11 3.9 4.11	设置下拉刷新阈值, 仅 refresher-default-style = 'none' 自定义样式下生效
refresher-max-drag-distance	number	-	Web Android iOS x 3.9 4.11	设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍
refresher-default-style	string	"black"	Web Android iOS 4.11 3.9 4.11	设置下拉刷新默认样式，支持设置 black | white | none， none 表示不使用默认样式
合法值 兼容性 描述 black Web Android iOS - 3.9 4.11 深颜色雪花样式 white Web Android iOS - 3.9 4.11 浅白色雪花样式 none Web Android iOS 4.11 3.93 4.11 不使用默认样式
refresher-background	string(string.ColorString)	"transparent"	Web Android iOS 4.11 3.9 4.11	设置下拉刷新区域背景颜色，默认透明
refresher-triggered	boolean	false	Web Android iOS 4.11 3.9 4.11	设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发
enable-back-to-top	boolean	false	Web Android iOS x x 4.11	iOS点击顶部状态栏滚动条返回顶部，只支持竖向
custom-nested-scroll	boolean	false	Web Android iOS x 3.9 4.11	子元素是否开启嵌套滚动 将滚动事件与父元素协商处理
@refresherpulling	(event: UniRefresherEvent) => void	-	Web Android iOS 4.11 3.9 4.11	下拉刷新控件被下拉
@refresherrefresh	(event: UniRefresherEvent) => void	-	Web Android iOS 4.11 3.9 4.11	下拉刷新被触发
@refresherrestore	(event: UniRefresherEvent) => void	-	Web Android iOS 4.11 3.9 4.11	下拉刷新被复位
@refresherabort	(event: UniRefresherEvent) => void	-	Web Android iOS 4.11 3.9 4.11	下拉刷新被中止
@scrolltoupper	(event: UniScrollToUpperEvent) => void	-	Web Android iOS 4.02 3.9 4.11	滚动到顶部/左边，会触发 scrolltoupper 事件
@scrolltolower	(event: UniScrollToLowerEvent) => void	-	Web Android iOS 4.02 3.9 4.11	滚动到底部/右边，会触发 scrolltolower 事件
@scroll	(event: UniScrollEvent) => void	-	Web Android iOS 4.02 3.9 4.11	滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}
@scrollend	(event: UniScrollEvent) => void	-	Web Android iOS x 3.9 4.11	滚动结束时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}
rebound	boolean	true	Web Android iOS x 3.9 4.11	控制是否回弹效果。已废弃，请改用bounces
scroll-y	boolean	true	Web Android iOS x 3.9 4.11	允许纵向滚动，不支持同时设置scroll-x属性为true，同时设置true时scroll-y生效。已废弃，请改用direction
scroll-x	boolean	false	Web Android iOS x 3.9 x	允许横向滚动，不支持同时设置scroll-y属性为true，同时设置true时scroll-y生效。已废弃，请改用direction

事件

UniRefresherEvent

UniRefresherEvent 的属性值

名称	类型	必填	默认值	兼容性	描述
detail	UniRefresherEventDetail	是	-	-	-
名称 类型 必备 默认值 兼容性 描述 dy number 是 - - -

UniScrollToUpperEvent

UniScrollToUpperEvent 的属性值

名称	类型	必填	默认值	兼容性	描述
detail	UniScrollToUpperEventDetail	是	-	-
名称 类型 必备 默认值 兼容性 描述 direction string 是 - - 滚动方向 top 或 left

UniScrollToLowerEvent

UniScrollToLowerEvent 的属性值

名称	类型	必填	默认值	兼容性	描述
detail	UniScrollToLowerEventDetail	是	-	-
名称 类型 必备 默认值 兼容性 描述 direction string 是 - - 滚动方向 bottom 或 right

UniScrollEvent

UniScrollEvent 的属性值

名称	类型	必填	默认值	兼容性	描述
detail	UniScrollEventDetail	是	-	-
名称 类型 必备 默认值 兼容性 描述 scrollTop number 是 - - 竖向滚动的距离 scrollLeft number 是 - - 横向滚动的距离 scrollHeight number 是 - - 滚动区域的高度 scrollWidth number 是 - - 滚动区域的宽度 deltaY number 是 - - 当次滚动事件竖向滚动量 deltaX number 是 - - 当次滚动事件横向滚动量

自定义下拉刷新样式

list-view组件有默认的下拉刷新样式，如果想自定义，则需使用自定义下拉刷新。

1. 设置refresher-default-style属性为 none 不使用默认样式
2. 设置 list-item 定义自定义下拉刷新元素并声明为 slot="refresher"，需要设置刷新元素宽高信息否则可能无法正常显示！

   <template>
   	<list-view refresher-default-style="none" :refresher-enabled="true" :refresher-triggered="refresherTriggered"
   			 @refresherpulling="onRefresherpulling" @refresherrefresh="onRefresherrefresh"
   			 @refresherrestore="onRefresherrestore" style="flex:1" >
   
   		<list-item v-for="i in 10" class="content-item">
   			<text class="text">item-{{i}}</text>
   		</list-item>
   
   		<!-- 自定义下拉刷新元素 -->
   		<list-item slot="refresher" class="refresh-box">
   			<text class="tip-text">{{text[state]}}</text>
   		</list-item>
   	</list-view>
   </template>
   

3. 通过组件提供的refresherpulling、refresherrefresh、refresherrestore、refresherabort下拉刷新事件调整自定义下拉刷新元素！实现预期效果

注意：

• 3.93版本开始支持
• 目前自定义下拉刷新元素不支持放在list-view的首个子元素位置上。可能无法正常显示

嵌套模式

scroll-view开启嵌套模式后，list-view 可作为内层滚动视图与外层 scroll-view 实现嵌套滚动

设置内层 list-view 的 associative-container 属性为 "nested-scroll-view"，开启内层 list-view 支持与外层 scroll-view 嵌套滚动

子组件

• list-item
• sticky-header
• sticky-section

示例

hello uni-app x

扫码体验（手机浏览器跳转到App直达页）

扫码体验

Template

Script

<template>
  <view class="main">
    <list-view :direction="scroll_direction" :rebound="bounces_boolean" :upper-threshold="upper_threshold_input"
      :lower-threshold="lower_threshold_input" :scroll-top="scroll_top_input" :scroll-left="scroll_left_input"
      :show-scrollbar="show_scrollbar_boolean" :scroll-into-view="scrollIntoView"
      :scroll-with-animation="scroll_with_animation_boolean" :refresher-enabled="refresher_enabled_boolean"
      :refresher-background="refresher_background_input" :refresher-triggered="refresher_triggered_boolean"
      :refresher-default-style="refresher_default_style_input" @click="list_view_click"
      @touchstart="list_view_touchstart" @touchmove="list_view_touchmove" @touchcancel="list_view_touchcancel"
      @touchend="list_view_touchend" @tap="list_view_tap" @longpress="list_view_longpress"
      @refresherpulling="list_view_refresherpulling" @refresherrefresh="list_view_refresherrefresh"
      @refresherrestore="list_view_refresherrestore" @refresherabort="list_view_refresherabort"
      @scrolltoupper="list_view_scrolltoupper" ref="listview" @scrolltolower="list_view_scrolltolower"
      @scroll="list_view_scroll" @scrollend="list_view_scrollend" style="width:100%;" id="listview">
      <list-item v-for="key in scrollData" :key="key" :id="key" @click="list_item_click"
        @touchstart="list_item_touchstart" @touchmove="list_item_touchmove" @touchcancel="list_item_touchcancel"
        @touchend="list_item_touchend" @tap="list_item_tap" @longpress="list_item_longpress" class="list-item">
        <text>{{key}}</text>
      </list-item>
      <!-- #ifdef APP -->
      <list-item slot="refresher" class="refresh-box">
        <text class="tip-text">{{text[state]}}</text>
      </list-item>
      <!-- #endif -->
    </list-view>
  </view>

  <scroll-view style="flex:1" direction="vertical">
    <view class="content">
      <!-- #ifdef APP -->
      <boolean-data :defaultValue="false" title="设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发"
        @change="change_refresher_triggered_boolean"></boolean-data>
      <boolean-data :defaultValue="false" title="开启下拉刷新" @change="change_refresher_enabled_boolean"></boolean-data>
      <boolean-data :defaultValue="false" title="开启自定义样式" @change="change_refresher_style_boolean"></boolean-data>
      <!-- #endif -->
      <boolean-data :defaultValue="false" title="是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画"
        @change="change_scroll_with_animation_boolean"></boolean-data>
      <boolean-data :defaultValue="false" title="控制是否出现滚动条" @change="change_show_scrollbar_boolean"></boolean-data>
      <!-- #ifdef APP -->
      <boolean-data :defaultValue="true" title="控制是否回弹效果" @change="change_bounces_boolean"></boolean-data>
      <!-- #endif -->
      <boolean-data :defaultValue="true" title="允许纵向滚动" @change="change_scroll_y_boolean"></boolean-data>
      <!-- #ifdef APP -->
      <boolean-data :defaultValue="false" title="允许横向滚动" @change="change_scroll_x_boolean"></boolean-data>
      <!-- #endif -->
      <input-data defaultValue="50" title="距顶部/左边多远时（单位px），触发 scrolltoupper 事件" type="number"
        @confirm="confirm_upper_threshold_input"></input-data>
      <input-data defaultValue="50" title="距底部/右边多远时（单位px），触发 scrolltolower 事件" type="number"
        @confirm="confirm_lower_threshold_input"></input-data>
      <input-data defaultValue="0" title="设置竖向滚动条位置" type="number" @confirm="confirm_scroll_top_input"></input-data>
      <!-- #ifdef APP -->
      <input-data defaultValue="0" title="设置横向滚动条位置" type="number" @confirm="confirm_scroll_left_input"></input-data>
      <input-data defaultValue="#FFF" title="设置下拉刷新区域背景颜色" type="text"
        @confirm="confirm_refresher_background_input"></input-data>
      <enum-data :items="size_enum" title="通过id位置跳转" @change="item_change_size_enum"></enum-data>
      <navigator url="/pages/component/list-view/list-view-refresh">
        <button type="primary" class="button">
          list-view 下拉刷新
        </button>
      </navigator>
      <!-- #endif -->
      <navigator url="/pages/component/list-view/list-view-multiplex">
        <button type="primary" class="button">
          list-view 对list-item复用测试
        </button>
      </navigator>
      <navigator url="/pages/component/list-view/list-view-multiplex-input">
        <button type="primary" class="button">
          list-view 复用测试（item中嵌入input）
        </button>
      </navigator>
      <navigator url="/pages/component/list-view/list-view-multiplex-video">
        <button type="primary" class="button">
          list-view 复用测试（item中嵌入video）
        </button>
      </navigator>
      <navigator url="/pages/component/list-view/list-view-children-in-slot">
        <button type="primary" class="button">
          list-view 测试插槽中子组件增删
        </button>
      </navigator>
    </view>
  </scroll-view>
</template>

<style>
  .main {
    max-height: 250px;
    padding: 5px 0;
    border-bottom: 1px solid rgba(0, 0, 0, .06);
    flex-direction: row;
    justify-content: center;
  }

  .main .list-item {
    width: 100%;
    height: 250px;
    border: 1px solid #666;
    background-color: #66ccff;
    align-items: center;
    justify-content: center;
  }

  .tip-text {
    color: #888;
    font-size: 12px;
  }

  .refresh-box {
    justify-content: center;
    align-items: center;
    flex-direction: row;
    height: 45px;
    width: 100%;
  }

  .button {
    margin-top: 15px;
  }
</style>

参见

• 相关 Bug
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

示例代码

• 联网联表：https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/template/list-news/list-news.uvue
• 可左右滑动的多个列表：https://gitcode.net/dcloud/hello-uni-app-x/-/tree/master/pages/template/long-list

Bug & Tips

• 如需im那样的倒序列表，App端可给组件style配置 transform: rotate(180deg) 来实现。注意与下拉刷新有冲突，此时应避免启用下拉刷新。
• 多列瀑布流是另外的组件，后续会提供。目前插件市场也有相关插件。
• list-view组件的overflow属性不支持配置visible
• 一次性初始化太多列表项，因为创建大量vnode耗时，会导致列表初始化变慢。此时推荐使用扩展组件uni-recycle-view来解决初始化慢的问题，该组件内部会分批创建节点，自动实现节点复用。