Vue的瀑布流组件-转自他人

这里只是做个记录,感谢作者!
文章原地址:点击查看

utils.js

/**
 * 从 itemElement 中抽离出所有的 imgElements
 */
export const getImgElements = (itemElements) => {
    const imgElements = []
    itemElements.forEach((el) => {
        imgElements.push(...el.getElementsByTagName('img'))
    })
    return imgElements
}

/**
 * 生成所有的图片链接数组
 */
export const getAllImg = (imgElements) => {
    return imgElements.map((imgElement) => {
        return imgElement.src
    })
}

/**
 * 监听图片数组加载完成(通过 promise 完成)
 */
export const onComplateImgs = (imgs) => {
    // promise 集合
    const promiseAll = []
    // 循环构建 promiseAll
    imgs.forEach((img, index) => {
        promiseAll[index] = new Promise((resolve, reject) => {
            const imageObj = new Image()
            imageObj.src = img
            imageObj.onload = () => {
                resolve({
                    img,
                    index
                })
            }
        })
    })
    return Promise.all(promiseAll)
}

/**
 * 返回列高对象中的最小高度所在的列
 */
export const getMinHeightColumn = (columnHeightObj) => {
    const minHeight = getMinHeight(columnHeightObj)
    return Object.keys(columnHeightObj).find((key) => {
        return columnHeightObj[key] === minHeight
    })
}

/**
 * 返回列高对象中的最小的高度
 */
export const getMinHeight = (columnHeightObj) => {
    const columnHeightArr = Object.values(columnHeightObj)
    return Math.min(...columnHeightArr)
}

/**
 * 返回列高对象中的最大的高度
 */
export const getMaxHeight = (columnHeightObj) => {
    const columnHeightArr = Object.values(columnHeightObj)
    return Math.max(...columnHeightArr)
}

Waterfall.vue

<template>
  <!-- 因为当前为 relative 布局,所以需要主动指定高度 -->
  <div
    class="relative"
    ref="containerTarget"
    :style="{ height: containerHeight + 'px' }"
  >
    <!-- 数据渲染 -->
    <!-- 因为列数不确定,所以需要根据列数计算每列的宽度,所以等待列宽计算完成,并且有了数据源之后进行渲染 -->
    <template v-if="columnWidth && data.length">
      <!-- 通过动态的 style 来去计算对应的列宽、left、top -->
      <div
        class="m-waterfall-item absolute duration-300"
        v-for="(item, index) in data"
        :key="nodeKey ? item[nodeKey] : index"
        :style="{
          width: columnWidth + 'px',
          left: item._style?.left + 'px',
          top: item._style?.top + 'px',
        }"
      >
        <slot :item="item" :index="index" :width="columnWidth" />
      </div>
    </template>

    <!-- 加载中的提示 -->
    <div v-else>加载中...</div>
  </div>
</template>

<script setup>
import {
  getImgElements,
  getAllImg,
  onComplateImgs,
  getMinHeightColumn,
  getMinHeight,
  getMaxHeight,
} from "./utils";
import { ref, watch, onMounted, onUnmounted, nextTick, computed } from "vue";

/**
   * 使用方式
   *  <m-waterfall class="px-1 w-full" :data="pexelsList" nodeKey="id" :column="isMobileTerminal ? 2 : 5" :picturePreReading="true">
        <template v-slot="{ item, width }">
          <ItemVue :data="item"></ItemVue>
        </template>
      </m-waterfall>
   */

const props = defineProps({
  // 数据源
  data: {
    type: Array,
    required: true,
  },
  // 唯一标识的 key
  nodeKey: {
    type: String,
  },
  // 列数
  column: {
    default: 2,
    type: Number,
  },
  // 列间距
  columnSpacing: {
    default: 20,
    type: Number,
  },
  // 行间距
  rowSpacing: {
    default: 20,
    type: Number,
  },
  // 是否需要进行图片预读取
  picturePreReading: {
    type: Boolean,
    default: true,
  },
});

// 容器的总高度
const containerHeight = ref(0);
// 记录每列高度的容器。key:所在列  val:列高
const columnHeightObj = ref({});
/**
 * 构建记录各列的高度的对象。
 */
const useColumnHeightObj = () => {
  columnHeightObj.value = {};
  for (let i = 0; i < props.column; i++) {
    columnHeightObj.value[i] = 0;
  }
};

// 容器实例
const containerTarget = ref(null);
// 容器总宽度(不包含 padding、margin、border)
const containerWidth = ref(0);
// 容器左边距,计算 item left 时,需要使用定位
const containerLeft = ref(0);
/**
 * 计算容器宽度
 */
const useContainerWidth = () => {
  const { paddingLeft, paddingRight } = getComputedStyle(
    containerTarget.value,
    null
  );
  // 容器左边距
  containerLeft.value = parseFloat(paddingLeft);
  // 容器宽度
  containerWidth.value =
    containerTarget.value.offsetWidth -
    parseFloat(paddingLeft) -
    parseFloat(paddingRight);
};

// 列宽 列宽=容器的宽度-所有列间距宽度 / 列数
const columnWidth = ref(0);
// 列间距合计
const columnSpacingTotal = computed(() => {
  // 如果是5列,则存在 4 个列间距
  return (props.column - 1) * props.columnSpacing;
});
/**
 * 开始计算
 */
const useColumnWidth = () => {
  // 获取容器宽度
  useContainerWidth();
  // 计算列宽
  columnWidth.value =
    (containerWidth.value - columnSpacingTotal.value) / props.column;
};
onMounted(() => {
  // 计算列宽
  useColumnWidth();
});

/**
 * 需要图片预加载时
 */
// item 高度集合
let itemHeights = [];
/**
 * 监听图片加载完成
 */
const waitImgComplate = () => {
  itemHeights = [];
  // 拿到所有元素
  let itemElements = [...document.getElementsByClassName("m-waterfall-item")];
  // 获取所有元素的 img 标签
  const imgElements = getImgElements(itemElements);
  // 获取所有 img 标签的图片
  const allImgs = getAllImg(imgElements);
  onComplateImgs(allImgs).then(() => {
    // 图片加载完成,获取高度
    itemElements.forEach((el) => {
      itemHeights.push(el.offsetHeight);
    });
    // 渲染位置
    useItemLocation();
  });
};

/**
 * 不需要图片预加载时,计算 item 高度
 */
const useItemHeight = () => {
  itemHeights = [];
  // 拿到所有元素
  let itemElements = [...document.getElementsByClassName("m-waterfall-item")];
  // 计算 item 高度
  itemElements.forEach((el) => {
    // 依据传入数据计算出的 img 高度
    itemHeights.push(el.offsetHeight);
  });
  // 渲染位置
  useItemLocation();
};

/**
 * 为每个 item 生成位置属性
 */
const useItemLocation = () => {
  // 遍历数据源
  props.data.forEach((item, index) => {
    // 避免重复计算
    if (item._style) {
      return;
    }
    // 生成 _style 属性
    item._style = {};
    // left
    item._style.left = getItemLeft();
    // top
    item._style.top = getItemTop();
    // 指定列高度自增
    increasingHeight(index);
  });

  // 指定容器高度
  containerHeight.value = getMaxHeight(columnHeightObj.value);
};
/**
 * 返回下一个 item 的 left
 */
const getItemLeft = () => {
  // 最小高度所在的列 * (列宽 + 间距)
  const column = getMinHeightColumn(columnHeightObj.value);
  return (
    column * (columnWidth.value + props.columnSpacing) + containerLeft.value
  );
};
/**
 * 返回下一个 item 的 top
 */
const getItemTop = () => {
  // 列高对象中的最小的高度
  return getMinHeight(columnHeightObj.value);
};
/**
 * 指定列高度自增
 */
const increasingHeight = (index) => {
  // 最小高度所在的列
  const minHeightColumn = getMinHeightColumn(columnHeightObj.value);
  // 该列高度自增
  columnHeightObj.value[minHeightColumn] +=
    itemHeights[index] + props.rowSpacing;
};
/**
 * 在组件销毁时,清除所有的 _style
 */
onUnmounted(() => {
  props.data.forEach((item) => {
    delete item._style;
  });
});

// 触发计算
watch(
  () => props.data,
  (newVal) => {
    // 重置数据源
    const resetColumnHeight = newVal.every((item) => !item._style);
    if (resetColumnHeight) {
      // 构建高度记录容器
      useColumnHeightObj();
    }
    nextTick(() => {
      if (props.picturePreReading) {
        waitImgComplate();
      } else {
        useItemHeight();
      }
    });
  },
  {
    immediate: true,
    deep: true,
  }
);

/**
 * 监听列数变化,重新构建瀑布流(解决最开始在移动端,点击切换到pc端再切换回移动端后容器宽度不一致问题)
 */
const reset = () => {
  setTimeout(() => {
    // 重新计算列宽
    useColumnWidth();
    // 重置所有的定位数据,因为 data 中进行了深度监听,所以该操作会触发 data 的 watch
    props.data.forEach((item) => {
      item._style = null;
    });
  }, 100);
};
watch(
  () => props.column,
  () => {
    if (props.picturePreReading) {
      // 在 picturePreReading 为 true 的前提下,需要首先为列宽滞空,列宽滞空之后,会取消瀑布流渲染
      columnWidth.value = 0;
      // 等待页面渲染之后,重新执行计算。否则在 item 没有指定过高度的前提下,计算出的 item 高度会不正确
      nextTick(reset);
    } else {
      reset();
    }
  }
);
</script>

<style scoped>
.relative {
  width: 100%;
  position: relative;
}
.m-waterfall-item {
  left: 0;
  top: 0;
  position: absolute;
}
</style>

如何使用组件?如下所示!
example.vue

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

推荐阅读更多精彩内容