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

智能推荐

攻防世界_难度8_happy_puzzle_攻防世界困难模式攻略图文-程序员宅基地

文章浏览阅读645次。这个肯定是末尾的IDAT了,因为IDAT必须要满了才会开始一下个IDAT,这个明显就是末尾的IDAT了。,对应下面的create_head()代码。,对应下面的create_tail()代码。不要考虑爆破,我已经试了一下,太多情况了。题目来源:UNCTF。_攻防世界困难模式攻略图文

达梦数据库的导出(备份)、导入_达梦数据库导入导出-程序员宅基地

文章浏览阅读2.9k次,点赞3次,收藏10次。偶尔会用到,记录、分享。1. 数据库导出1.1 切换到dmdba用户su - dmdba1.2 进入达梦数据库安装路径的bin目录,执行导库操作  导出语句:./dexp cwy_init/[email protected]:5236 file=cwy_init.dmp log=cwy_init_exp.log 注释:   cwy_init/init_123..._达梦数据库导入导出

js引入kindeditor富文本编辑器的使用_kindeditor.js-程序员宅基地

文章浏览阅读1.9k次。1. 在官网上下载KindEditor文件,可以删掉不需要要到的jsp,asp,asp.net和php文件夹。接着把文件夹放到项目文件目录下。2. 修改html文件,在页面引入js文件:<script type="text/javascript" src="./kindeditor/kindeditor-all.js"></script><script type="text/javascript" src="./kindeditor/lang/zh-CN.js"_kindeditor.js

STM32学习过程记录11——基于STM32G431CBU6硬件SPI+DMA的高效WS2812B控制方法-程序员宅基地

文章浏览阅读2.3k次,点赞6次,收藏14次。SPI的详情简介不必赘述。假设我们通过SPI发送0xAA,我们的数据线就会变为10101010,通过修改不同的内容,即可修改SPI中0和1的持续时间。比如0xF0即为前半周期为高电平,后半周期为低电平的状态。在SPI的通信模式中,CPHA配置会影响该实验,下图展示了不同采样位置的SPI时序图[1]。CPOL = 0,CPHA = 1:CLK空闲状态 = 低电平,数据在下降沿采样,并在上升沿移出CPOL = 0,CPHA = 0:CLK空闲状态 = 低电平,数据在上升沿采样,并在下降沿移出。_stm32g431cbu6

计算机网络-数据链路层_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输-程序员宅基地

文章浏览阅读1.2k次,点赞2次,收藏8次。数据链路层习题自测问题1.数据链路(即逻辑链路)与链路(即物理链路)有何区别?“电路接通了”与”数据链路接通了”的区别何在?2.数据链路层中的链路控制包括哪些功能?试讨论数据链路层做成可靠的链路层有哪些优点和缺点。3.网络适配器的作用是什么?网络适配器工作在哪一层?4.数据链路层的三个基本问题(帧定界、透明传输和差错检测)为什么都必须加以解决?5.如果在数据链路层不进行帧定界,会发生什么问题?6.PPP协议的主要特点是什么?为什么PPP不使用帧的编号?PPP适用于什么情况?为什么PPP协议不_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输

软件测试工程师移民加拿大_无证移民,未受过软件工程师的教育(第1部分)-程序员宅基地

文章浏览阅读587次。软件测试工程师移民加拿大 无证移民,未受过软件工程师的教育(第1部分) (Undocumented Immigrant With No Education to Software Engineer(Part 1))Before I start, I want you to please bear with me on the way I write, I have very little gen...

随便推点

Thinkpad X250 secure boot failed 启动失败问题解决_安装完系统提示secureboot failure-程序员宅基地

文章浏览阅读304次。Thinkpad X250笔记本电脑,装的是FreeBSD,进入BIOS修改虚拟化配置(其后可能是误设置了安全开机),保存退出后系统无法启动,显示:secure boot failed ,把自己惊出一身冷汗,因为这台笔记本刚好还没开始做备份.....根据错误提示,到bios里面去找相关配置,在Security里面找到了Secure Boot选项,发现果然被设置为Enabled,将其修改为Disabled ,再开机,终于正常启动了。_安装完系统提示secureboot failure

C++如何做字符串分割(5种方法)_c++ 字符串分割-程序员宅基地

文章浏览阅读10w+次,点赞93次,收藏352次。1、用strtok函数进行字符串分割原型: char *strtok(char *str, const char *delim);功能:分解字符串为一组字符串。参数说明:str为要分解的字符串,delim为分隔符字符串。返回值:从str开头开始的一个个被分割的串。当没有被分割的串时则返回NULL。其它:strtok函数线程不安全,可以使用strtok_r替代。示例://借助strtok实现split#include <string.h>#include <stdio.h&_c++ 字符串分割

2013第四届蓝桥杯 C/C++本科A组 真题答案解析_2013年第四届c a组蓝桥杯省赛真题解答-程序员宅基地

文章浏览阅读2.3k次。1 .高斯日记 大数学家高斯有个好习惯:无论如何都要记日记。他的日记有个与众不同的地方,他从不注明年月日,而是用一个整数代替,比如:4210后来人们知道,那个整数就是日期,它表示那一天是高斯出生后的第几天。这或许也是个好习惯,它时时刻刻提醒着主人:日子又过去一天,还有多少时光可以用于浪费呢?高斯出生于:1777年4月30日。在高斯发现的一个重要定理的日记_2013年第四届c a组蓝桥杯省赛真题解答

基于供需算法优化的核极限学习机(KELM)分类算法-程序员宅基地

文章浏览阅读851次,点赞17次,收藏22次。摘要:本文利用供需算法对核极限学习机(KELM)进行优化,并用于分类。

metasploitable2渗透测试_metasploitable2怎么进入-程序员宅基地

文章浏览阅读1.1k次。一、系统弱密码登录1、在kali上执行命令行telnet 192.168.26.1292、Login和password都输入msfadmin3、登录成功,进入系统4、测试如下:二、MySQL弱密码登录:1、在kali上执行mysql –h 192.168.26.129 –u root2、登录成功,进入MySQL系统3、测试效果:三、PostgreSQL弱密码登录1、在Kali上执行psql -h 192.168.26.129 –U post..._metasploitable2怎么进入

Python学习之路:从入门到精通的指南_python人工智能开发从入门到精通pdf-程序员宅基地

文章浏览阅读257次。本文将为初学者提供Python学习的详细指南,从Python的历史、基础语法和数据类型到面向对象编程、模块和库的使用。通过本文,您将能够掌握Python编程的核心概念,为今后的编程学习和实践打下坚实基础。_python人工智能开发从入门到精通pdf

推荐文章

热门文章

相关标签