vue3 + vue-pdf-embed实现放大、缩小、滚动翻页功能-程序员宅基地

技术标签: pdf  vue.js  javascript  实战积累  

安装依赖

npm install vue-pdf-embed -S

封装组件:因为UI同事有设计预览样式,不能用默认,以及综合各种因素考虑,将PDF组件作为子组件套在弹窗父组件中。

父组件

<template>
    <!-- 预览弹窗 -->
    <Dialog
        :title="$t('message.preview')"
        :visible="showPDFPreviewDialog"
        @handleClose="switchPDFPreviewDialog"
    >
        <template v-slot:content>
            <p class="preview_title">{
    {
     pdfTitle }}</p>
            <div class="pdf_centent" id="pdfCentent">
                <PdfPreview
                    :pdfSource="pdfSource"
                    :isChangeToNextPage="isChangeToNextPage"
                    :isChangeToPrePage="isChangeToPrePage"
                    @clickDownloadBtn="previweClickDownBtn"
                    @switchIsChangeToNextPage="switchIsChangeToNextPage"
                    @switchIsChangeToPrePage="switchIsChangeToPrePage"
                />
            </div>
        </template>
        <template v-slot:footer v-if="false">
        </template>
    </Dialog>
</template>
<script setup>
import {
     ref, defineAsyncComponent } from 'vue'
//异步组件
const PdfPreview = defineAsyncComponent(() => import('@/components/pagecom/pdfPreview.vue'))

const props = defineProps({
    
    showPDFPreviewDialog: {
        //dialog是否展示
        type: Boolean,
        default: false,
    },
    switchPDFPreviewDialog: {
        // 切换对话框的显示状态
        type: Function,
        default: () => {
    }
    },
    previweClickDownBtn: {
        // 预览界面点击下载
        type: Function,
        default: () => {
    }
    },
    pdfSource: {
        // pft链接
        type: String,
        default: ''
    },
    pdfTitle: {
        // pdf标题
        type: String,
        default: ''
    },
    
})
const isChangeToNextPage = ref(false)    // 是否向下翻页
const isChangeToPrePage = ref(false)    // 是否向上翻页
const switchIsChangeToNextPage = value => {
         // 滚动到当前页面底部时的操作
    let pdfCentent = document.getElementById('pdfCentent')
    let _scrollHeight = pdfCentent.scrollHeight
    let _scrollBottomNow = pdfCentent.scrollTop + pdfCentent.clientHeight
    // 当滚动到底部且没有向下翻页过,此时子组件即将向下翻页,因为翻页之后滚动条的位置仍处于底部,再次向下滚动会出现连续翻页的问题,故而父组件将滚动条恢复至页面顶部,并修改状态
    // 修改点:不能用当下开发的边界值,有些屏幕不一致时会出问题
    if (_scrollBottomNow === _scrollHeight && !isChangeToNextPage.value) {
    
        pdfCentent.scrollTop = 0
    }
    isChangeToNextPage.value = value    // 修改是否向下翻页的状态
}
const switchIsChangeToPrePage = value => {
         // 滚动到当前页面顶部时的操作
    let pdfCentent = document.getElementById('pdfCentent')
    let _scrollBottom = pdfCentent.scrollHeight - pdfCentent.clientHeight
    // 当滚动到顶部且没有向上翻页过,此时子组件即将向上翻页,因为翻页之后滚动条的位置仍处于顶部,再次向上滚动会出现连续翻页的问题,故而父组件将滚动条恢复至页面底部,并修改状态
    if (pdfCentent.scrollTop === 0 && !isChangeToPrePage.value) {
    
        pdfCentent.scrollTop = _scrollBottom
    }
    isChangeToPrePage.value = value    // 修改是否向上翻页的状态
}
</script>
<style lang="less" scoped>
.preview_title {
    
    position: absolute;;
    top: 66px;
    left: 0px;
    width: 100%;
    padding-left: 24px;
    height: 50px;
    line-height: 50px;
    border-bottom: 1px solid #e7e7e7;
    background-color: #fff;
    z-index: 99;
    box-sizing: border-box;
}
.pdf_centent {
    
    width: calc(100% + 48px);
    height: calc(100% - 18px);
    margin-top: 42px;
    margin-left: -24px;
    padding-left: 24px;
    padding-bottom: 24px;
    border-bottom-left-radius: 8px;
    border-bottom-right-radius: 8px;
    background-color: #fff;
    overflow-y: auto;
    overflow-x: auto;
    box-sizing: border-box;
}
</style>

子组件

<template>
  <div style="margin-top: 20px;">
    <template v-if="state.isLoading">{
    {
     $t('message.pdfLoading') }}</template>
  </div>

  <div class="over_wrap" id="pdfWrap">
    <VuePdfEmbed
      ref="pdfRef"
      :source="pdfSource"
      :page="state.page"
      :style="scaleFun"
      @rendered="handleDocumentRender"
    />
    <div class="bottom_btns_wrap">
      <!-- 上一页 -->
      <span :class="{btn_disabled: state.page <= 1}" @click="clickPageUp"></span>
      <!-- 页码信息 -->
      <span>{
    {
    state.page}}/{
    {
     state.pageCount }}</span>
      <!-- <span><input type="text" :value="state.page" @input="replaceValue" @blur="changePage" />/<i>{
    {
     state.pageCount }}</i></span> -->
      <!-- 下一页 -->
      <span :class="{btn_disabled: state.page >= state.pageCount}" @click="clickPageDown"></span>
      <!-- 分隔符 -->
      <span class="bar"></span>
      <!-- 缩小 -->
      <span :class="{btn_disabled: false}" @click="clickCanvaReduce"></span>
      <!-- 缩放信息 -->
      <span>{
    {
     widthZoom }}</span>
      <!-- 放大 -->
      <span :class="{btn_disabled: false}" @click="clickCanvaAmplify"></span>
      <!-- 分隔符 -->
      <span class="bar"></span>
      <!-- 下载 -->
      <span @click="clickDownloadBtn"></span>
    </div>
  </div>
</template>
  
<script setup>
import {
     ref, reactive, computed, watch, onMounted, onUnmounted } from 'vue';
import VuePdfEmbed from 'vue-pdf-embed'

const props = defineProps({
    
  pdfSource: {
    
    type: String,
    default: ''
  },
  isChangeToNextPage: {
    
    type: Boolean,
    default: false
  },
  isChangeToPrePage: {
    
    type: Boolean,
    default: false
  }
})
const emit = defineEmits(['clickDownloadBtn', 'switchIsChangeToNextPage', 'switchIsChangeToPrePage'])
const pdfRef = ref()
const state = reactive({
    
  isLoading: true,
  page: null,
  pageCount: 1,
  showAllPages: false,  // 单页显示
  scale: 1,
  canvaWidth: 0.5,
})
const widthZoom = computed(() => `${
      (state.scale * 100).toFixed(0)}%`)
const scaleFun = computed(() => {
    
  let scale = state.scale;
  return `transform:scale(${
      scale})`;
})

watch(() => state.showAllPages,  // 不能去除,去除监听后会默认显示所有页面
  () => {
    
    state.page = state.showAllPages ? null : 1
  },
  {
    immediate: true}
)

const clickDownloadBtn = () => emit('clickDownloadBtn')
const handleDocumentRender = () => {
        // PDF加载
  state.isLoading = false
  state.pageCount = pdfRef.value.pageCount
}
const clickPageUp = () => state.page <= 1 ? '' : state.page--    // 向前翻页 按钮
const clickPageDown = () => state.page >= state.pageCount ? '' : state.page++    // 向后翻页 按钮
const clickCanvaAmplify = () => {
        // 放大按钮
  state.scale >= 1.5 ? '' : state.scale = Number((state.scale + 0.1).toFixed(1))
}
const clickCanvaReduce = () => {
         // 缩小按钮
  state.scale <= 0.5 ? '' : state.scale = Number((state.scale - 0.1).toFixed(1))
}
const replaceValue = (event) => {
        // input输入限制  需求没有这个功能没用到
  event.target.value = event.target.value.replace(/^(0+)|[^\d]+/g,'')
}
const changePage = (event) => {
        // 输入翻页触发
  if(event.target.value=='') {
    
    event.target.value = state.page
  } else if(event.target.value > state.pageCount) {
    
    event.target.value = state.page
  } else {
    
    state.page = event.target.value
  }
}

onMounted(() => {
    
  document.onmousewheel = event => {
    
  	// 获取元素的各个高度
    let el = document.getElementById('pdfCentent')
    let _scrollHeight = el.scrollHeight
    let _scrollTopNow = el.scrollTop + el.clientHeight
    let _clientHeight = el.clientHeight
    
    if (event.wheelDelta > 0 || event.detail < 0) {
       // 向上滚
    // 滚动到顶部,不是第一页,且没有向上滚动翻页过
      if (_scrollTopNow === _clientHeight && state.page !== 1 && !props.isChangeToPrePage) {
    
      	// 在翻页前先触发父组件方法,将滚动条设置到底部
        emit('switchIsChangeToPrePage', true)
      	// 进行翻页
        state.page -= 1
        // 将向上翻页状态恢复至默认
        emit('switchIsChangeToPrePage', false)
      }
    } else if (event.wheelDelta < 0 || event.detail > 0) {
         // 向下滚
    // 滚动到底部,不是第最后一页,且没有向下滚动翻页过
      if(_scrollTopNow === _scrollHeight && state.page !== state.pageCount && !props.isChangeToNextPage) {
    
      	// 在翻页前先触发父组件方法,将滚动条设置到顶部
        emit('switchIsChangeToNextPage', true)
      	// 进行翻页
        state.page += 1
        // 将向下翻页状态恢复至默认
        emit('switchIsChangeToNextPage', false)
      }
    }
  }
})
// 清空滚轮事件
onUnmounted(() => document.onmousewheel = null)
</script>

<style lang="less" scoped>
.over_wrap {
     height: 100%;}
.bottom_btns_wrap {
    
  position: absolute;
  left: 50%;
  bottom: 32px;
  transform: translateX(-50%);
  padding: 8px 21px;
  min-width: 337px;
  height: 44px;
  background: rgba(0,0,0,0.8);
  color: #fff;
  // opacity: 0.8;
  // background: #000;
  border-radius: 8px;
  box-sizing: border-box;

  span {
     display: inline-block; width: 28px; height: 28px; cursor: pointer;
    &:hover {
     border-radius: 4px; }
  }
  span:nth-child(2),span:nth-child(6) {
     position: relative; top: -8px;}
  span:nth-child(1) {
    
    background: url('@/assets/img/pdf_pgup.png') no-repeat center;
    &:hover {
     background: url('@/assets/img/pdf_pgup.png') no-repeat center #484848; }
    &:active {
     background: url('@/assets/img/pdf_pgup.png') no-repeat center #3d3d3d; }
  }
  span:nth-child(2) {
     
    margin: 0 11px ; width: 60px; line-height: 22px; height: 22px;user-select: none;text-align: center;
    input {
     display: inline-block;max-width: 26px; text-align: right;background-color: transparent;color: #fff;}
  }
  span:nth-child(3) {
    
    background: url('@/assets/img/pdf_pgdn.png') no-repeat center;
    &:hover {
     background: url('@/assets/img/pdf_pgdn.png') no-repeat center #484848; }
    &:active {
     background: url('@/assets/img/pdf_pgdn.png') no-repeat center #3d3d3d; }
  }
  span:nth-child(5) {
    
    background: url('@/assets/img/pdf_reduce.png') no-repeat center;
    &:hover {
     background: url('@/assets/img/pdf_reduce.png') no-repeat center #484848; }
    &:active {
     background: url('@/assets/img/pdf_reduce.png') no-repeat center #3d3d3d; }
  }
  span:nth-child(6) {
     margin: 0 11px; width: 42px;line-height: 22px;user-select: none;}
  span:nth-child(7) {
    
    background: url('@/assets/img/pdf_amplify.png') no-repeat center;
    &:hover {
     background: url('@/assets/img/pdf_amplify.png') no-repeat center #484848; }
    &:active {
     background: url('@/assets/img/pdf_amplify.png') no-repeat center #3d3d3d; }
  }
  span:nth-child(9) {
    
    background: url('@/assets/img/pdf_download.png') no-repeat center;
    &:hover {
     background: url('@/assets/img/pdf_download.png') no-repeat center #484848; }
    &:active {
     background: url('@/assets/img/pdf_download.png') no-repeat center #3d3d3d; }
  }
  .bar {
    
    width: 1px !important;
    height: 16px;
    background-color: #565657;
    margin: 5px 10.5px;
  }
  .btn_disabled {
     cursor: no-drop;}
}
::v-deep .vue-pdf-embed {
    
  margin-top: 18px;
  // margin-right: 20px;
  overflow: auto;
  transform-origin: center;
}
::v-deep .vue-pdf-embed>div {
    
  margin-bottom: 18px;
}
::v-deep .vue-pdf-embed canvas {
    
  width: 98% !important;
  border: 1px solid #e7e7e7;
  box-shadow: 0px 2px 8px 0px rgba(0,0,0,0.10); 
}
</style>

总结

接到这个需求时找了挺多依赖,被推荐最多的是vue-pdf,但用不了,依稀记得有样式不好调整,并且有不适用vue3的问题。写这篇文章的时间离需求开发过去应该有半年多了,记不太清了。总之,试了几个依赖后选择了vue-pdf-embed,官网示例
放大功能还有些缺陷,放很大时没有滚动条,暂时没有解决,所幸需求限制只能放大到150%,当下开发任务重就没有继续研究。

滚动翻页功能是最近的优化需求,在官网没有找到直接实现的方法,翻了翻网络,都是其他依赖的帖子,而且也没有滚动翻页的功能,思来想去,决定通过监听滚动距离来实现。

起初以切都还顺利,到了将滚动条设置到顶部 / 底部时,是通过子组件的pdf内容页来获取滚动距离,但是一直没有获取到,卡了半天突然想起项目中有个地方也修改过滚动距离,查看了下代码,才发现是获取的父容器的滚动距离。将这点解决,功能也就完成得差不多了,使用起来观感也算丝滑,虽然原理上感觉不那么丝滑,但总归实现了不是,目测也不会有什么大bug。

后来想了想,scrollTop为什么是父容器在改变,子组件一直都是零,个人思考结论是:滚动条是父容器的滚动条,不是子组件的。之前一直想的是子组件的内容在动,理应修改子组件的scrollTop,谁知一直是0。因此在修改scrollTop时需要获取父组件的,之前没有注意过这点。

结论正确性有待考究,先记录一下。

==================================
2024/02/29 回顾
写文章时想不起来子组件72行的去除监听后会显示所有页面是什么意思,今天想起来了。

去除之后会竖向排列显示所有页面,当时没有去除应该是翻页不好实现,现在想想也未可知。如果显示所有页面的话,把超出部分overflow滚动其他,那是不是就直接实现了滚动翻页;但可能存在页码更新困难的问题。

基于当前没有什么bug,就不做可行性实验了,记录一下思路。

==================================
修改点:将边界值由开发时获取的定值改为动态获取的值。
开发时没有考虑到屏幕可视高度不一致时会出现偏差导致功能实现不了的问题,且DOM的各个高度的概念没有查询清楚模糊点而使用了定值,DOM的各个高度的概念还是要记牢不能模糊概念才好。

参考:判断滚动条是否滚动到页面底部

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/littlesamll/article/details/135750536

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk

随便推点

matlab(4):特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析 时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;amp;gt;Jni-&amp;amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法