Vue 手写图片瀑布流组件(附源码)

时间 2020-07-02

标签 vue 手写图片瀑布组件源码栏目悠闲生活繁體版

原文原文链接

前言

瀑布流，又称瀑布流式布局。是比较流行的一种网站页面布局，视觉表现为良莠不齐的多栏布局，随着页面滚动条向下滚动，这种布局还会不断加载数据块并附加至当前尾部。

最终实现效果以下css

滚动加载：

宽度自适应：
vue

原理

分析可发现，该瀑布流每一个图片元素宽度相等，高度不一样；且从第二行开始，每一个元素实际上都是插入到最小高度的那一列上。typescript

emmmm，就这么简单......数组

布局

布局比较简单
容器设置'position: relative;'相对定位，图片元素设置'position: absolute;'绝对定位bash

<div class="waterfall_box">
  <div class="waterfall_item">
  </div>
</div>

.waterfall_box {
  position: relative;
  margin: 0 auto;
  .waterfall_item {
    float: left;
    position: absolute;
    img {
      width: 100%;
      height: auto;
    }
  }
}

实现

直接上代码比较容易理解
Vue template 结构dom

<template>
  <div class="waterfall_box" ref="waterfall_box" :style="`height:${waterfall_box_height_exect}`">
    <template v-if="waterfall_col_num>1">
      <div v-for="(img,index) in waterfall_list" class="waterfall_item" :style="{top:img.top+'px',left:img.left+'px',width:img_width+'px',height:img.height}" :key="index">
        <slot :row="img"></slot>
      </div>
    </template>
    <!-- 列数小于1 没有瀑布流的必要，直接正常布局便可 -->
    <template v-else>
      <div v-for="(img,index) in img_list" :key="index" style="margin-bottom: 20px;">
        <slot :row="img"></slot>
      </div>
    </template>
  </div>
</template>

定义变量async

@Prop({ required: true, type: Array })
readonly img_list!: [];

@Prop({ required: true, type: Number }) # 图片宽度
readonly img_width!: number;

@Prop({ required: true, type: Number }) # 图片下边距
readonly img_margin_bottom!: number;

img_margin_right!: number; # 图片右边距

/* 容器宽高 */
waterfall_box_width = 0;

waterfall_box_height = 0;

waterfall_col_num = 0; # 列数

waterfall_col_height_list: Array<number> = []; # 每列最大高度

waterfall_list = []; # 瀑布流用到的数据

接下来就是重点,也是直接上代码函数

初始化一些必要参数

# 算出当前视图宽度最多能够放几列，向下取整
  this.waterfall_col_num = Math.floor(this.waterfall_box_width / this.img_width) || 1;
  # 根据列数存储一个临时数组，用于存放当前每一列的最小高度
  this.waterfall_col_height_list = new Array(this.waterfall_col_num).fill(0);
  # 算出每行图片之间的间隙
  this.img_margin_right = (this.waterfall_box_width - this.waterfall_col_num * this.img_width) / (this.waterfall_col_num - 1);
  # 只有一列，很明显没有瀑布流布局的必要了，直接正常布局
  if (this.waterfall_col_num <= 1) return;
  this.layoutWatreFall();

瀑布流布局计算

# 用一个临时存储，所有计算完再更新Vue数据
  const temp_waterfall_list: any = [];
  # 遍历每一个图片数据，动态加一些其余参数。每轮遍历都把该数据加入到最小高度的那一列并设置left和top
  this.img_list.forEach((img_item: any) => {
    const minIndex = this.finMinHeightIndex();
    const img_obj = {
      ...img_item,
      url: img_item.url,
      width: this.img_width,
      height: Math.floor((this.img_width / img_item.width) * img_item.height), # 图片等比例缩放
      top: this.waterfall_col_height_list[minIndex],
      left: minIndex * (this.img_margin_right + this.img_width),
    };
    temp_waterfall_list.push(img_obj);
    this.waterfall_col_height_list[minIndex] += img_obj.height + this.img_margin_bottom; # 每次放完元素，实时更新每一个列数的最小高度
  });
  this.waterfall_list = temp_waterfall_list;
  this.waterfall_box_height = Math.max.call(null, ...this.waterfall_col_height_list); # 更新父容器的高度

辅助函数

# 找到数组最小值下标
  finMinHeightIndex() {
    return this.waterfall_col_height_list.indexOf(Math.min.call(null, ...this.waterfall_col_height_list));
  }

源码

使用,传一个图片宽度，和下边距便可布局

<v-water-fall :img_list="photo_list" :img_width="250" :img_margin_bottom="20" class="photo_img_box">
  <template slot-scope="scope">
    <img v-lazy="scope.row.url"> # 做用域插槽
  </template>
</v-water-fall>

源码网站

<template>
  <div class="waterfall_box" ref="waterfall_box" :style="`height:${waterfall_box_height_exect}`">
    <template v-if="waterfall_col_num>1">
      <div v-for="(img,index) in waterfall_list" class="waterfall_item" :style="{top:img.top+'px',left:img.left+'px',width:img_width+'px',height:img.height}" :key="index">
        <slot :row="img"></slot> # 做用域插槽
      </div>
    </template>
    <!-- 列数小于1 没有瀑布流的必要，直接正常布局便可 -->
    <template v-else>
      <div v-for="(img,index) in img_list" :key="index" style="margin-bottom: 20px;">
        <slot :row="img"></slot> # 做用域插槽
      </div>
    </template>
  </div>
</template>

<script lang="ts">
/* eslint-disable @typescript-eslint/no-explicit-any */
import {
  Vue, Component, Prop, Watch,
} from 'vue-property-decorator';

@Component({})
export default class WaterFall extends Vue {
  @Prop({ required: true, type: Array })
  readonly img_list!: [];

  @Prop({ required: true, type: Number }) // 图片宽度
  readonly img_width!: number;

  @Prop({ required: true, type: Number }) // 图片下边距
  readonly img_margin_bottom!: number;

  img_margin_right!: number; // 图片右边距

  /* 容器宽高 */
  waterfall_box_width = 0;

  waterfall_box_height = 0;

  waterfall_col_num = 0; // 列数

  waterfall_col_height_list: Array<number> = []; // 每列最大高度

  waterfall_list = []; // 瀑布流用到的数据

  // 容器的高度 拼上单位
  get waterfall_box_height_exect() {
    return this.waterfall_col_num <= 1 ? 'auto' : `${this.waterfall_box_height}px`;
  }

  @Watch('img_list')
  img_list_change() {
    this.initParam();
  }

  async mounted() {
    const waterfall_box_dom: any = this.$refs.waterfall_box;
    this.waterfall_box_width = waterfall_box_dom.offsetWidth;
    window.addEventListener('resize', this.afreshLayoutWaterFall);
  }

  beforeDestroy() {
    window.removeEventListener('resize', this.afreshLayoutWaterFall);
  }


  /* ---------------------- */
  initParam() {
    this.waterfall_col_num = Math.floor(this.waterfall_box_width / this.img_width) || 1;
    this.waterfall_col_height_list = new Array(this.waterfall_col_num).fill(0);
    this.img_margin_right = (this.waterfall_box_width - this.waterfall_col_num * this.img_width) / (this.waterfall_col_num - 1);
    if (this.waterfall_col_num <= 1) return;
    this.layoutWatreFall();
  }

  // 瀑布流布局
  layoutWatreFall() {
    const temp_waterfall_list: any = [];
    this.img_list.forEach((img_item: any) => {
      const minIndex = this.finMinHeightIndex();
      const img_obj = {
        ...img_item,
        url: img_item.url,
        width: this.img_width,
        height: Math.floor((this.img_width / img_item.width) * img_item.height),
        top: this.waterfall_col_height_list[minIndex],
        left: minIndex * (this.img_margin_right + this.img_width),
      };
      temp_waterfall_list.push(img_obj);
      this.waterfall_col_height_list[minIndex] += img_obj.height + this.img_margin_bottom;
    });
    this.waterfall_list = temp_waterfall_list;
    // console.log(this.waterfall_list);
    this.waterfall_box_height = Math.max.call(null, ...this.waterfall_col_height_list);
  }

  // 找到数组最小值下标
  finMinHeightIndex() {
    return this.waterfall_col_height_list.indexOf(Math.min.call(null, ...this.waterfall_col_height_list));
  }

  afreshLayoutWaterFall() {
    const waterfall_box_dom: any = this.$refs.waterfall_box;
    if (waterfall_box_dom) {
      this.waterfall_box_width = waterfall_box_dom.offsetWidth;
      this.initParam();
    }
  }
}
</script>

<style lang="scss" scoped>
.waterfall_box {
  position: relative;
  margin: 0 auto;
  .waterfall_item {
    float: left;
    position: absolute;
    img {
      width: 100%;
      height: auto;
    }
  }
}
</style>

END