scroller

v0.6.1+

<scroller> 是一个竖直的，可以容纳多个排成一列的子组件的滚动器。如果子组件的总高度高于其本身，那么所有的子组件都可滚动。

注意： <scroller> 可以当作根元素或者嵌套元素使用。此组件的滚动方向是垂直方向的形式。

子组件

支持任意类型的 Weex 组件作为其子组件。 其中，还支持以下两个特殊组件作为子组件：

  • <refresh>

    用于给列表添加下拉刷新的功能。

    使用文档请查看 <refresh>

  • <loading>

    <loading> 用法与特性和 <refresh> 类似，用于给列表添加上拉加载更多的功能。

    使用文档请查看 <loading>

特性

  • show-scrollbar {boolean}：可选值为 true/ false，默认值为 true。控制是否出现滚动条。

  • scroll-direction {string}：可选为 horizontal 或者 vertical，默认值为 vertical 。定义滚动的方向。

    • scroll-direction定义了 scroller 的滚动方向，样式表属性 flex-direction 定义了 scroller 的布局方向，两个方向必须一致。
    • scroll-direction 的默认值是 vertical, flex-direction 的默认值是 row。
    • 当需要一个水平方向的 scroller 时，使用 scroll-direction:horizontal 和 flex-direction: row。
    • 当需要一个竖直方向的 scroller 时，使用 scroll-direction:vertical 和 flex-direction: column。由于这两个值均是默认值，当需要一个竖直方向的 scroller 时，这两个值可以不设置。

  • loadmoreoffset {number}：默认值为 0，触发 loadmore 事件所需要的垂直偏移距离（设备屏幕底部与页面底部之间的距离）。当页面的滚动条滚动到足够接近页面底部时将会触发 loadmore 这个事件。

    mobile_preview

  • loadmoreretry {number}：默认值为 0，当 loadmore 失败时是否重置 loadmore 相关的 UI，值不一样就会重置。 该属性已废弃，请使用resetLoadmore()函数实现重置loadmore的操作。

  • offset-accuracy {number} 0.11+：控制onscroll事件触发的频率，默认值为10，表示两次onscroll事件之间列表至少滚动了10px。注意，将该值设置为较小的数值会提高滚动事件采样的精度，但同时也会降低页面的性能。

  • offset-accuracy：默认值是0，触发 scroll 事件所需要的垂直偏移距离。

样式

  • 通用样式：支持所有通用样式

    • 盒模型
    • flexbox 布局
    • position
    • opacity
    • background-color

    查看 组件通用样式

事件

  • loadmore v0.5+：如果滚动到底部将会立即触发这个事件，你可以在这个事件的处理函数中加载下一页的列表项。

  • scroll 0.11+: 列表发生滚动时将会触发该事件，事件的默认抽样率为10px，即列表每滚动10px触发一次，可通过属性offset-accuracy设置抽样率。 参见 scroll event demo。

    事件中 event 对象属性：

    • contentSize {Object}：列表的内容尺寸
      • width {number}: 列表内容宽度
      • height {number}: 列表内容高度
    • contentOffset {Object}: 列表的偏移尺寸
      • x {number}: x轴上的偏移量
      • y {number}: y轴上的偏移量

  • 支持 scrollstart 和 scrollend 事件 0.17+ .当列表开始或者结束滚动的时候会分别触发相应的 scrollstart 和 scrollend 事件，当前的内容高度和列表偏移会在callback中返回。可以参见这个example

  • 通用事件

    支持所有通用事件：

    • click
    • longpress
    • appear
    • disappear

    查看 通用事件

扩展

scrollToElement(node, options)

滚动到列表某个指定项是常见需求，<list> 拓展了该功能支持滚动到指定 <cell>。通过 dom module 访问，更多信息可参考 dom module 。

0.9+" class="reference-link">resetLoadmore() 0.9+

在默认情况下，触发loadmore事件后，如果列表中内容没有发生变更，则下一次滚动到列表末尾时将不会再次触发loadmore事件，你可以通过调用resetLoadmore()方法来打破这一限制，调用该方法后，下一次滚动到列表末尾时将强制触发loadmore。

参数

  • node {node}：指定目标节点。
  • options {Object}：
    • offset {number}：一个到其可见位置的偏移距离，默认是0

约束

不允许相同方向的 <list> 或者 <scroller> 互相嵌套，换句话说就是嵌套的 <list>/<scroller> 必须是不同的方向。

举个例子，不允许一个垂直方向的 <list> 嵌套的一个垂直方向的 <scroller> 中，但是一个垂直方向的 <list> 是可以嵌套的一个水平方向的 <list> 或者 <scroller> 中的。

示例

  1. <template>
  2.   <div class="wrapper">
  3.     <scroller class="scroller">
  4.       <div class="row" v-for="(name, index) in rows" :ref="'item'+index">
  5.         <text class="text" :ref="'text'+index">{{name}}</text>
  6.       </div>
  7.     </scroller>
  8.     <div class="group">
  9.       <text @click="goto10" class="button">Go to 10</text>
  10.       <text @click="goto20" class="button">Go to 20</text>
  11.     </div>
  12.   </div>
  13. </template>
  15. <script>
  16.   const dom = weex.requireModule('dom')
  18.   export default {
  19.     data () {
  20.       return {
  21.         rows: []
  22.       }
  23.     },
  24.     created () {
  25.       for (let i = 0; i < 30; i++) {
  26.         this.rows.push('row ' + i)
  27.       }
  28.     },
  29.     methods: {
  30.       goto10 (count) {
  31.         const el = this.$refs.item10[0]
  32.         dom.scrollToElement(el, {})
  33.       },
  34.       goto20 (count) {
  35.         const el = this.$refs.item20[0]
  36.         dom.scrollToElement(el, { offset: 0 })
  37.       }
  38.     }
  39.   }
  40. </script>
  42. <style scoped>
  43.   .scroller {
  44.     width: 700px;
  45.     height: 700px;
  46.     border-width: 3px;
  47.     border-style: solid;
  48.     border-color: rgb(162, 217, 192);
  49.     margin-left: 25px;
  50.   }
  51.   .row {
  52.     height: 100px;
  53.     flex-direction: column;
  54.     justify-content: center;
  55.     padding-left: 30px;
  56.     border-bottom-width: 2px;
  57.     border-bottom-style: solid;
  58.     border-bottom-color: #DDDDDD;
  59.   }
  60.   .text {
  61.     font-size: 45px;
  62.     color: #666666;
  63.   }
  64.   .group {
  65.     flex-direction: row;
  66.     justify-content: center;
  67.     margin-top: 60px;
  68.   }
  69.   .button {
  70.     width: 200px;
  71.     padding-top: 20px;
  72.     padding-bottom: 20px;
  73.     font-size: 40px;
  74.     margin-left: 30px;
  75.     margin-right: 30px;
  76.     text-align: center;
  77.     color: #41B883;
  78.     border-width: 2px;
  79.     border-style: solid;
  80.     border-color: rgb(162, 217, 192);
  81.     background-color: rgba(162, 217, 192, 0.2);
  82.   }
  83. </style>

try it