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

智能推荐

c# 调用c++ lib静态库_c#调用lib-程序员宅基地

文章浏览阅读2w次,点赞7次,收藏51次。四个步骤1.创建C++ Win32项目动态库dll 2.在Win32项目动态库中添加 外部依赖项 lib头文件和lib库3.导出C接口4.c#调用c++动态库开始你的表演...①创建一个空白的解决方案,在解决方案中添加 Visual C++ , Win32 项目空白解决方案的创建:添加Visual C++ , Win32 项目这......_c#调用lib

deepin/ubuntu安装苹方字体-程序员宅基地

文章浏览阅读4.6k次。苹方字体是苹果系统上的黑体,挺好看的。注重颜值的网站都会使用,例如知乎:font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, PingFang SC, Microsoft YaHei, Source Han Sans SC, Noto Sans CJK SC, W..._ubuntu pingfang

html表单常见操作汇总_html表单的处理程序有那些-程序员宅基地

文章浏览阅读159次。表单表单概述表单标签表单域按钮控件demo表单标签表单标签基本语法结构<form action="处理数据程序的url地址“ method=”get|post“ name="表单名称”></form><!--action,当提交表单时,向何处发送表单中的数据,地址可以是相对地址也可以是绝对地址--><!--method将表单中的数据传送给服务器处理,get方式直接显示在url地址中,数据可以被缓存,且长度有限制;而post方式数据隐藏传输,_html表单的处理程序有那些

PHP设置谷歌验证器(Google Authenticator)实现操作二步验证_php otp 验证器-程序员宅基地

文章浏览阅读1.2k次。使用说明:开启Google的登陆二步验证(即Google Authenticator服务)后用户登陆时需要输入额外由手机客户端生成的一次性密码。实现Google Authenticator功能需要服务器端和客户端的支持。服务器端负责密钥的生成、验证一次性密码是否正确。客户端记录密钥后生成一次性密码。下载谷歌验证类库文件放到项目合适位置(我这边放在项目Vender下面)https://github.com/PHPGangsta/GoogleAuthenticatorPHP代码示例://引入谷_php otp 验证器

【Python】matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距-程序员宅基地

文章浏览阅读4.3k次,点赞5次,收藏11次。matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距

docker — 容器存储_docker 保存容器-程序员宅基地

文章浏览阅读2.2k次。①Storage driver 处理各镜像层及容器层的处理细节,实现了多层数据的堆叠,为用户 提供了多层数据合并后的统一视图②所有 Storage driver 都使用可堆叠图像层和写时复制(CoW)策略③docker info 命令可查看当系统上的 storage driver主要用于测试目的,不建议用于生成环境。_docker 保存容器

随便推点

网络拓扑结构_网络拓扑csdn-程序员宅基地

文章浏览阅读834次,点赞27次,收藏13次。网络拓扑结构是指计算机网络中各组件(如计算机、服务器、打印机、路由器、交换机等设备)及其连接线路在物理布局或逻辑构型上的排列形式。这种布局不仅描述了设备间的实际物理连接方式,也决定了数据在网络中流动的路径和方式。不同的网络拓扑结构影响着网络的性能、可靠性、可扩展性及管理维护的难易程度。_网络拓扑csdn

JS重写Date函数,兼容IOS系统_date.prototype 将所有 ios-程序员宅基地

文章浏览阅读1.8k次,点赞5次,收藏8次。IOS系统Date的坑要创建一个指定时间的new Date对象时,通常的做法是:new Date("2020-09-21 11:11:00")这行代码在 PC 端和安卓端都是正常的,而在 iOS 端则会提示 Invalid Date 无效日期。在IOS年月日中间的横岗许换成斜杠,也就是new Date("2020/09/21 11:11:00")通常为了兼容IOS的这个坑,需要做一些额外的特殊处理,笔者在开发的时候经常会忘了兼容IOS系统。所以就想试着重写Date函数,一劳永逸,避免每次ne_date.prototype 将所有 ios

如何将EXCEL表导入plsql数据库中-程序员宅基地

文章浏览阅读5.3k次。方法一:用PLSQL Developer工具。 1 在PLSQL Developer的sql window里输入select * from test for update; 2 按F8执行 3 打开锁, 再按一下加号. 鼠标点到第一列的列头,使全列成选中状态,然后粘贴,最后commit提交即可。(前提..._excel导入pl/sql

Git常用命令速查手册-程序员宅基地

文章浏览阅读83次。Git常用命令速查手册1、初始化仓库git init2、将文件添加到仓库git add 文件名 # 将工作区的某个文件添加到暂存区 git add -u # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,不处理untracked的文件git add -A # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,包括untracked的文件...

分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120-程序员宅基地

文章浏览阅读202次。分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120

【C++缺省函数】 空类默认产生的6个类成员函数_空类默认产生哪些类成员函数-程序员宅基地

文章浏览阅读1.8k次。版权声明:转载请注明出处 http://blog.csdn.net/irean_lau。目录(?)[+]1、缺省构造函数。2、缺省拷贝构造函数。3、 缺省析构函数。4、缺省赋值运算符。5、缺省取址运算符。6、 缺省取址运算符 const。[cpp] view plain copy_空类默认产生哪些类成员函数

推荐文章

热门文章

相关标签