vue-waterfall-easy 2.x

vue-waterfall-easy 2.x

  1. 这是一个vue组件,包含瀑布流布局和无限滚动加载
  2. 相比其他实现方式,无需在返回的数据中指定图片的宽度和高度
  3. 正是因为第2条,所以采用的是图片预加载之后,再排版
  4. 响应式,兼容移动端
  5. 支持无图模式(@2.4.0)
  6. 使用及其简单

在线DEMO

Demo案例代码

更新列表

github

1. 使用

1.1 npm安装

npm install vue-waterfall-easy --save-dev

1.2 es6语法引用

import vueWaterfallEasy from 'vue-waterfall-easy'

export default {
  name: 'app',
  components: {
    vueWaterfallEasy
  }
}

1.3 js引用

下载vueWaterfallEasy.js

<script src="path/to/vue/vue.js"></script>
<script src="path/to/vueWaterfallEasy.js"></script>
new Vue({
  el: '#app',
  components: {
    vueWaterfallEasy
  }
})

1.4 支持 require.js sea.js 模块引用

2. 基本示例

html

<vue-waterfall-easy :imgsArr="imgsArr" @scrollReachBottom="getData"></vue-waterfall-easy>

如果imgArr是替换更新,getData新请求返回的数据覆盖原来的数据。

如果imgArr是增量更新,getData新请求返回的数据与原来的数据进行合并,此时不建议使用替换更新,会浪费性能。下面这个例子就是增量更新。

js

import vueWaterfallEasy from './vue-waterfall-easy/vue-waterfall-easy.vue'
import axios from 'axios'

export default {
  name: 'app',
  data() {
    return {
      imgsArr: [],
      group: 0, // request param
    }
  },
  components: {
    vueWaterfallEasy
  },
  methods: {
    getData() {
      axios.get('./static/mock/data.json?group=' + this.group) // 真实环境中,后端会根据参数group返回新的图片数组,这里我用一个惊呆json文件模拟
        .then(res => {
          this.imgsArr = this.imgsArr.concat(res.data)
          this.group++
        })
    },
  },
  created() {
    this.getData()
  }
}

详情见仓库App.vue文件

3. 组件参数

参数 类型 默认值 描述
width Number - 容器宽度(px),默认是相对父元素宽度100%,由于响应式,此时其所有上级元素宽度必须都是相对浏览器窗口100%,具体看该表格下面实例。
如果为定宽的话,必须设置width值,而不能只是其父元素设置定宽
height Number|String - 容器高度,值为Number类型时默认单位px,值为String类型时可指定单位
当不传递height值时,默认是相对父元素高度100%,此时父元素必须具有高度
gap Number 20 单位:px
pc端图片之间的间距
mobileGap Number 8 单位:px
移动端图片之间的间距
imgsArr Array [] 必填
用于渲染瀑布流的数据
每个数组元素是个对象,应该要有src和href属性
src属性代表图片的src属性
href属性代表点击跳转的链接
如果你的键值不是srchref,你可以使用srcKeyhrefKey这两个属性进行键值装换
srcKey String 'src' 当你的图片地址键值不为src,可以使用该属性进行转换
hrefKey String 'href' 当你的图片地址键值不为href,可以使用该属性进行转换
imgWidth Number 240 单位:px
图片的宽度
maxCols Number 5 瀑布流显示最大的列数
linkRange String 'card' 标识点击触发跳转链接范围,值有:
'card' 整张卡牌范围跳转链接
'img' 卡片内图片范围
custom 自定义可以通过slot插槽自定义跳转链接元素
isRouterLink Boolean false 值为false时渲染a标签,值为true时渲染router-link组件
reachBottomDistance Number 0 单位:px
滚动触发scrollReachBottom事件时的距离容器底部的距离
loadingDotCount Number 3 默认loading动画点的数量
loadingDotStyle Object null 默认loading动画内小圆点的样式对象,可以自定义其样式
loadingTimeOut Number 500 单位:ms
预加载事件小于500毫秒就不显示加载动画,增加用户体验
cardAnimationClass String 'default-card-animation' 用于给图片设置出现时的动画的calssName,如要去掉默认动画可以这样设置cardAnimationClass=""
enablePullDownEvent Boolean false 开启下拉事件

waterfall组件祖先元素css样式

详情见 App.vue 文件

html,
body,
#app {
  height: 100%; // 父元素必须要有高度
  width: 100%; // 如果已经是block元素,则可以忽略
}

4. 事件

事件名 描述
scrollReachBottom 滚动条滚动到底部时,用于请求新的图片数据
preloaded 每次图片预加载完成执行
click 当卡片被点击时触发,看下面的实例
imgError 图片加载错误事件,第一个参数可获取到当前加载错误图片的相关数据
pullDownMove 移动端生效,触摸下拉事件,第一个参数可获取Y轴移动距离差,常用于下拉刷新
pullDownEnd 移动端生效,触摸下拉事件手指抬起,常用于下拉刷新

click事件使用实例

<vue-waterfall-easy :imgsArr="imgsArr" @scrollReachBottom="getData" @click="clickFn"></vue-waterfall-easy>
  clickFn(event, { index, value }) {
    // 阻止a标签跳转
    event.preventDefault()
    // 只有当点击到图片时才进行操作
    if (event.target.tagName.toLowerCase() == 'img') {
      console.log('img clicked',index, value)
    }
  }

5. 组件方法

5.1 waterfallOver

当滚动加载数据结束时,手动调用,将会取消滚动加载

this.$refs.waterfall.waterfallOver()

详情见仓库App.vue文件

6. slot插槽

6.1 默认slot

进行自定义图片的描述信息

参数说明

参数 描述
props.index 图片在数组中的索引,从0开始
props.value 遍历参数imgsArr的元素值
<vue-waterfall-easy :imgsArr="imgsArr" @scrollReachBottom="getData">
  <div class="img-info" slot-scope="props">
    <p class="some-info">第{{props.index+1}}张图片</p>
    <p class="some-info">{{props.value.info}}</p>
  </div>
</vue-waterfall-easy>

6.2 slot="loading"

自定义加载动画

<div slot="loading" slot-scope="{isFirstLoad}">
  <div slot="loading" v-if="isFirstLoad">first-loading...</div>
  <div v-else="v-else">loading...</div>
</div>

6.3 slot="waterfall-head"

容器头部内容插槽

<vue-waterfall-easy :imgsArr="imgsArr" @scrollReachBottom="getData">
  <div slot="waterfall-head">waterfall-head</div>
</vue-waterfall-easy>

6.4 slot="waterfall-over"

调用waterfallOver方法后才会显示,用于瀑布流结束提醒,默认值是被你看光了

<vue-waterfall-easy :imgsArr="imgsArr" @scrollReachBottom="getData">
  <div slot="waterfall-over">waterfall-over</div>
</vue-waterfall-easy>

7. 兼容移动端

别忘记在index.html head中添加一下代码

<meta name="viewport" content="width=device-width, initial-scale=1,maximum-scale=1, user-scalable=no">
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容

  • Vue-Music 一| 前期工作 1.项目初始化 npm install -g vue-cli vue init...
    noobakong阅读 1,828评论 0 5
  • 这篇笔记主要包含 Vue 2 不同于 Vue 1 或者特有的内容,还有我对于 Vue 1.0 印象不深的内容。关于...
    云之外阅读 5,048评论 0 29
  • 聚会同学,从未推却,即便刮风下雪。 时光未老鬓发白,偶尔相逢人雀跃。 欢天喜地,兴高采烈,友谊长存勿缺。 容颜易老...
    高原_4697阅读 238评论 2 4
  • 上帝天生的给了我们一条平均线,关于你是牛是马,出生后是定下来来的。对于抵抗压力值,也是确定的,我们如果没有借助外部...
    黑八先生阅读 278评论 0 3
  • 掌门_艾老师阅读 196评论 0 0