简体中文
简体中文
# waterflow
组件类型：UniWaterFlowElement
瀑布流组件
# 兼容性
| Web | 微信小程序 | Android | iOS |
|---|---|---|---|
| x | x | 4.41 | 4.41 |
在App中，waterflow 底层实现与list-view底层实现方式基本一致，仅子组件排列方式存在差异，适用于多元素瀑布流长列表场景，子组件滑动出屏幕会及时回收复用。性能优于 scroll-view
waterflow 暂时只支持 flow-item 组件为子组件，其他组件不可见
waterflow 只支持竖向滚动，暂时不支持横向滚动
# 属性
| 名称 | 类型 | 默认值 | 兼容性 | 描述 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cross-axis-count | number | 2 | 交叉轴元素数量 | |||||||||||||
| main-axis-gap | number | 0 | 主轴方向间隔 | |||||||||||||
| cross-axis-gap | number | 0 | 交叉轴方向间隔 | |||||||||||||
| padding | Array | [0,0,0,0] | 长度为 4 的数组，按 top、right、bottom、left 顺序指定内边距 | |||||||||||||
| associative-container | string | - | 关联的滚动容器 | |||||||||||||
| ||||||||||||||||
| bounces | boolean | true | 控制是否回弹效果 | |||||||||||||
| upper-threshold | number | 50 | 距顶部/左边多远时（单位px），触发 scrolltoupper 事件 | |||||||||||||
| lower-threshold | number | 50 | 距底部/右边多远时（单位px），触发 scrolltolower 事件 | |||||||||||||
| scroll-top | number | 0 | 设置竖向滚动条位置 | |||||||||||||
| show-scrollbar | boolean | true | 控制是否出现滚动条 | |||||||||||||
| scroll-into-view | string(string.IDString) | - | 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素起始位置 | |||||||||||||
| scroll-with-animation | boolean | false | 是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画 | |||||||||||||
| refresher-enabled | boolean | false | 开启下拉刷新，暂时不支持scroll-x = true横向刷新 | |||||||||||||
| refresher-threshold | number | 45 | 设置下拉刷新阈值, 仅 refresher-default-style = 'none' 自定义样式下生效 | |||||||||||||
| refresher-max-drag-distance | number | - | 设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍 | |||||||||||||
| refresher-default-style | string | "black" | 设置下拉刷新默认样式，支持设置 black | white | none， none 表示不使用默认样式 | |||||||||||||
| ||||||||||||||||
| refresher-background | string(string.ColorString) | "transparent" | 设置下拉刷新区域背景颜色，默认透明 | |||||||||||||
| refresher-triggered | boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 | |||||||||||||
| enable-back-to-top | boolean | false | iOS点击顶部状态栏滚动条返回顶部，只支持竖向 | |||||||||||||
| custom-nested-scroll | boolean | false | 子元素是否开启嵌套滚动 将滚动事件与父元素协商处理 | |||||||||||||
| @refresherpulling | (event: UniRefresherEvent) => void | - | 下拉刷新控件被下拉 | |||||||||||||
| @refresherrefresh | (event: UniRefresherEvent) => void | - | 下拉刷新被触发 | |||||||||||||
| @refresherrestore | (event: UniRefresherEvent) => void | - | 下拉刷新被复位 | |||||||||||||
| @refresherabort | (event: UniRefresherEvent) => void | - | 下拉刷新被中止 | |||||||||||||
| @scrolltoupper | (event: UniScrollToUpperEvent) => void | - | 滚动到顶部/左边，会触发 scrolltoupper 事件 | |||||||||||||
| @scrolltolower | (event: UniScrollToLowerEvent) => void | - | 滚动到底部/右边，会触发 scrolltolower 事件 | |||||||||||||
| @scroll | (event: UniScrollEvent) => void | - | 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} | |||||||||||||
| @scrollend | (event: UniScrollEvent) => void | - | 滚动结束时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} | |||||||||||||
# 事件
# UniRefresherEvent
# UniRefresherEvent 的属性值
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail | UniRefresherEventDetail | 是 | - | - | - | ||||||||||||
| |||||||||||||||||
# UniScrollToUpperEvent
# UniScrollToUpperEvent 的属性值
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail | UniScrollToUpperEventDetail | 是 | - | - | |||||||||||||
| |||||||||||||||||
# UniScrollToLowerEvent
# UniScrollToLowerEvent 的属性值
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail | UniScrollToLowerEventDetail | 是 | - | - | |||||||||||||
| |||||||||||||||||
# UniScrollEvent
# UniScrollEvent 的属性值
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| detail | UniScrollEventDetail | 是 | - | - | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
# 自定义下拉刷新样式
waterflow组件有默认的下拉刷新样式，如果想自定义，则需使用自定义下拉刷新。
- 设置
refresher-default-style属性为 none 不使用默认样式 - 设置 flow-item 定义自定义下拉刷新元素并声明为
slot="refresher"，需要设置刷新元素宽高信息否则可能无法正常显示！<template> <waterflow refresher-default-style="none" :refresher-enabled="true" :refresher-triggered="refresherTriggered" @refresherpulling="onRefresherpulling" @refresherrefresh="onRefresherrefresh" @refresherrestore="onRefresherrestore" style="flex:1" > <flow-item v-for="i in 10" class="content-item" type=1> <text class="text">item-{{i}}</text> </flow-item> <!-- 自定义下拉刷新元素 --> <flow-item slot="refresher" class="refresh-box" type=2> <text class="tip-text">{{text[state]}}</text> </flow-item> </waterflow> </template> - 通过组件提供的refresherpulling、refresherrefresh、refresherrestore、refresherabort下拉刷新事件调整自定义下拉刷新元素！实现预期效果
注意：
- 目前自定义下拉刷新元素不支持放在waterflow的首个子元素位置上。可能无法正常显示
# 加载更多(load-more)
由于 waterflow 组件是多列的，单个 flow-item 组件无法占用一整行，加载更多展示不太友好，所以我们提供了slot="load-more"属性配置，waterflow 组件会特殊处理最后一个 flow-item 子组件，如果配置了slot="load-more"则显示一整行
<template>
<waterflow style="flex:1" >
<flow-item v-for="i in 10" class="content-item" type=1>
<text class="text">item-{{i}}</text>
</flow-item>
<flow-item slot="load-more" id="loadmore" type=3 class="load-more-box">
<text>加载更多</text>
</flow-item>
</waterflow>
</template>
注意：
- slot="load-more"仅对 waterflow 最后一个 flow-item 子组件生效
# 嵌套模式
scroll-view开启嵌套模式后，waterflow 可作为内层滚动视图与外层 scroll-view 实现嵌套滚动
设置内层 waterflow 的 associative-container 属性为 "nested-scroll-view"，开启内层 waterflow 支持与外层 scroll-view 嵌套滚动
# 子组件
| 子组件 | 兼容性 |
|---|---|
| flow-item |
# 示例
该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验
<script>
type ScrollEventTest = {
type : string;
target : UniElement | null;
currentTarget : UniElement | null;
direction ?: string
}
type flowItemData = {
height : number,
text : string
}
import { ItemType } from '@/components/enum-data/enum-data-types'
export default {
data() {
return {
refresher_triggered_boolean: false,
refresher_enabled_boolean: false,
scroll_with_animation_boolean: false,
show_scrollbar_boolean: false,
bounces_boolean: true,
upper_threshold_input: 50,
lower_threshold_input: 50,
scroll_top_input: 0,
scroll_left_input: 0,
refresher_background_input: "#FFF",
scrollData: [] as Array<flowItemData>,
size_enum: [{ "value": 0, "name": "item---0" }, { "value": 3, "name": "item---3" }] as ItemType[],
scrollIntoView: "",
refresherrefresh: false,
refresher_default_style_input: "black",
text: ['继续下拉执行刷新', '释放立即刷新', '刷新中', ""],
state: 3,
reset: true,
// 自动化测试
isScrollTest: '',
isScrolltolowerTest: '',
isScrolltoupperTest: '',
scrollDetailTest: null as UniScrollEventDetail | null,
scrollEndDetailTest: null as UniScrollEventDetail | null,
cross_axis_count: 2,
main_axis_gap: 2,
cross_axis_gap: 2,
waterflowPadding: [10, 5, 10, 5] as Array<number>,
loadMore: true,
isLoadMore: true
}
},
onLoad() {
//静态瀑布流数据
this.scrollData = [
{ height: 300, text: "item---0" },
{ height: 150, text: "item---1" },
{ height: 120, text: "item---2" },
{ height: 100, text: "item---3" },
{ height: 100, text: "item---4" },
{ height: 150, text: "item---5" },
{ height: 140, text: "item---6" },
{ height: 190, text: "item---7" },
{ height: 160, text: "item---8" },
{ height: 120, text: "item---9" },
{ height: 109, text: "item---10" },
{ height: 102, text: "item---11" },
{ height: 123, text: "item---12" },
{ height: 156, text: "item---13" },
{ height: 177, text: "item---14" },
{ height: 105, text: "item---15" },
{ height: 110, text: "item---16" },
{ height: 90, text: "item---17" },
{ height: 130, text: "item---18" },
{ height: 140, text: "item---19" },
] as Array<flowItemData>
},
methods: {
waterflow_click() { console.log("组件被点击时触发") },
waterflow_touchstart() { console.log("手指触摸动作开始") },
waterflow_touchmove() { console.log("手指触摸后移动") },
waterflow_touchcancel() { console.log("手指触摸动作被打断，如来电提醒，弹窗") },
waterflow_touchend() { console.log("手指触摸动作结束") },
waterflow_tap() { console.log("手指触摸后马上离开") },
waterflow_longpress() { console.log("如果一个组件被绑定了 longpress 事件，那么当用户长按这个组件时，该事件将会被触发。") },
waterflow_refresherpulling(e : RefresherEvent) {
console.log("下拉刷新控件被下拉")
if (this.reset) {
if (e.detail.dy > 45) {
this.state = 1
} else {
this.state = 0
}
}
},
waterflow_refresherrefresh() {
console.log("下拉刷新被触发 ")
this.refresherrefresh = true
this.refresher_triggered_boolean = true
this.state = 2
this.reset = false;
setTimeout(() => {
this.refresher_triggered_boolean = false
}, 1500)
},
waterflow_refresherrestore() {
this.refresherrefresh = false
this.state = 3
this.reset = true
console.log("下拉刷新被复位")
},
waterflow_refresherabort() { console.log("下拉刷新被中止") },
waterflow_scrolltoupper(e : UniScrollToUpperEvent) {
console.log("滚动到顶部/左边，会触发 scrolltoupper 事件 direction=" + e.detail.direction)
this.checkEventTest({
type: e.type,
target: e.target,
currentTarget: e.currentTarget,
direction: e.detail.direction,
} as ScrollEventTest, 'scrolltoupper')
},
waterflow_scrolltolower(e : UniScrollToLowerEvent) {
console.log("滚动到底部/右边，会触发 scrolltolower 事件 direction=" + e.detail.direction)
this.checkEventTest({
type: e.type,
target: e.target,
currentTarget: e.currentTarget,
direction: e.detail.direction,
} as ScrollEventTest, 'scrolltolower')
},
waterflow_scroll(e : UniScrollEvent) {
console.log("滚动时触发，event.detail = ", e.detail)
this.scrollDetailTest = e.detail
this.checkEventTest({
type: e.type,
target: e.target,
currentTarget: e.currentTarget
} as ScrollEventTest, 'scroll')
},
waterflow_scrollend(e : UniScrollEvent) {
console.log("滚动结束时触发", e.detail)
this.scrollEndDetailTest = e.detail
this.checkEventTest({
type: e.type,
target: e.target,
currentTarget: e.currentTarget
} as ScrollEventTest, 'scrollend')
},
flow_item_click() { console.log("flow-item组件被点击时触发") },
flow_item_touchstart() { console.log("手指触摸flow-item组件动作开始") },
flow_item_touchmove() { console.log("手指触摸flow-item组件后移动") },
flow_item_touchcancel() { console.log("手指触摸flow-item组件动作被打断，如来电提醒，弹窗") },
flow_item_touchend() { console.log("手指触摸flow-item组件动作结束") },
flow_item_tap() { console.log("手指触摸flow-item组件后马上离开") },
flow_item_longpress() { console.log("flow-item组件被绑定了 longpress 事件，那么当用户长按这个组件时，该事件将会被触发。") },
change_refresher_triggered_boolean(checked : boolean) { this.refresher_triggered_boolean = checked },
change_refresher_enabled_boolean(checked : boolean) { this.refresher_enabled_boolean = checked },
change_scroll_with_animation_boolean(checked : boolean) { this.scroll_with_animation_boolean = checked },
change_show_scrollbar_boolean(checked : boolean) { this.show_scrollbar_boolean = checked },
change_bounces_boolean(checked : boolean) { this.bounces_boolean = checked },
confirm_upper_threshold_input(value : number) { this.upper_threshold_input = value },
confirm_lower_threshold_input(value : number) { this.lower_threshold_input = value },
confirm_scroll_top_input(value : number) { this.scroll_top_input = value },
confirm_scroll_left_input(value : number) { this.scroll_left_input = value },
confirm_refresher_background_input(value : string) { this.refresher_background_input = value },
item_change_size_enum(index : number) { this.scrollIntoView = "item---" + index },
//自动化测试专用
setScrollIntoView(id : string) { this.scrollIntoView = id },
// 自动化测试专用（由于事件event参数对象中存在循环引用，在ios端JSON.stringify报错，自动化测试无法page.data获取）
checkEventTest(e : ScrollEventTest, eventName : String) {
const isPass = e.type === eventName && e.target instanceof UniElement && e.currentTarget instanceof UniElement;
const result = isPass ? `${eventName}:Success` : `${eventName}:Fail`;
switch (eventName) {
case 'scroll':
this.isScrollTest = result
break;
case 'scrolltolower':
this.isScrolltolowerTest = result + `-${e.direction}`
break;
case 'scrolltoupper':
this.isScrolltoupperTest = result + `-${e.direction}`
break;
default:
break;
}
},
//自动化测试例专用
check_scroll_height() : Boolean {
var listElement = this.$refs["waterflow"] as UniElement
console.log("check_scroll_height--" + listElement.scrollHeight)
if (listElement.scrollHeight > 1400) {
return true
}
return false
},
change_refresher_style_boolean(checked : boolean) {
if (checked) {
this.refresher_default_style_input = "none"
} else {
this.refresher_default_style_input = "black"
}
},
change_load_more_boolean(checked : boolean) {
this.isLoadMore = checked
},
handleChangeCrossAxisCount(value : number) {
if (value < 2) {
uni.showToast({ title: "cross-axis-count 最小值为 2 请重新设置" })
return
}
this.cross_axis_count = value
},
handleChangeCrossAxisGap(e : UniSliderChangeEvent) {
this.cross_axis_gap = e.detail.value
},
handleChangeMainAxisGap(e : UniSliderChangeEvent) {
this.main_axis_gap = e.detail.value
},
//仅自动化测试调用
testModifyWaterflowProps() {
this.cross_axis_count = 4
this.main_axis_gap = 6
this.cross_axis_gap = 6
this.waterflowPadding = [5, 10, 5, 10] as Array<number>
}
}
}
</script>
<template>
<view class="main">
<waterflow :cross-axis-count="cross_axis_count" :main-axis-gap="main_axis_gap" :cross-axis-gap="cross_axis_gap"
:bounces="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="waterflow_click" @touchstart="waterflow_touchstart" @touchmove="waterflow_touchmove"
@touchcancel="waterflow_touchcancel" @touchend="waterflow_touchend" @tap="waterflow_tap"
@longpress="waterflow_longpress" @refresherpulling="waterflow_refresherpulling"
@refresherrefresh="waterflow_refresherrefresh" @refresherrestore="waterflow_refresherrestore"
@refresherabort="waterflow_refresherabort" @scrolltoupper="waterflow_scrolltoupper" ref="waterflow"
@scrolltolower="waterflow_scrolltolower" @scroll="waterflow_scroll" @scrollend="waterflow_scrollend"
style="width:100%; " id="waterflow" :padding="waterflowPadding">
<flow-item v-for="(item, index) in scrollData" :key="index" :id="item.text" @click="flow_item_click"
:style="{'height' : item.height}" @touchstart="flow_item_touchstart" @touchmove="flow_item_touchmove"
@touchcancel="flow_item_touchcancel" @touchend="flow_item_touchend" @tap="flow_item_tap"
@longpress="flow_item_longpress" class="flow-item" type=1>
<text>{{item.text}}</text>
</flow-item>
<flow-item slot="refresher" id="refresher" type=2 class="refresh-box">
<text class="tip-text">{{text[state]}}</text>
</flow-item>
<flow-item v-show="isLoadMore" slot="load-more" id="loadmore" type=6 class="load-more-box">
<text>加载更多</text>
</flow-item>
</waterflow>
</view>
<scroll-view style="flex:1" direction="vertical">
<view class="content">
<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>
<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>
<boolean-data :defaultValue="true" title="控制是否回弹效果" @change="change_bounces_boolean"></boolean-data>
<boolean-data :defaultValue="true" title="是否显示加载更多" @change="change_load_more_boolean"></boolean-data>
<input-data defaultValue="2" title="设置cross-axis-count，触发 scrolltoupper 事件" type="number"
@confirm="handleChangeCrossAxisCount"></input-data>
<view class="uni-slider uni-list-cell-padding">
<text>拖动设置cross-axis-gap</text>
</view>
<view class="uni-slider uni-list-cell-padding">
<slider :max="20" :min="0" :step="1" :value="cross_axis_gap" :show-value="true"
@change="handleChangeCrossAxisGap" />
</view>
<view class="uni-slider uni-list-cell-padding">
<text>拖动设置main-axis-gap</text>
</view>
<view class="uni-slider uni-list-cell-padding">
<slider :max="20" :min="0" :step="1" :value="main_axis_gap" :show-value="true"
@change="handleChangeMainAxisGap" />
</view>
<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>
<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>
</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;
}
.flow-item {
width: 100%;
height: 200px;
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%;
}
.load-more-box {
justify-content: center;
align-items: center;
flex-direction: row;
height: 45px;
width: 100%;
border-style: solid;
}
.button {
margin-top: 15px;
}
</style>
# 参见
# App平台
- waterflow 组件默认高度是计算后瀑布流高度，无法滚动，如需要滚动要设置高度小于瀑布流高度，推荐配置 "flex:1"
- waterflow 组件在排版完毕UI展示后，如果子组件高度放生变化，则会重新排版，flow-item 组件的UI会出现短暂的错乱和位置位移，建议控制子元素高度固定避免动态修改高度
- 场景一 image组件设置mode=widthFix，加载的网络图片会出现异步图片下载动态修改高度的情况，容易出现上述问题
- 场景二 rich-text组件nodes节点内容存在网络图片，出现异步加载情况，会出现动态修改高度导致出现上述问题
