@neosjs/pdf-viewer
基于 Mozilla PDF.js 封装的 Vue 3 PDF 预览组件。开箱即用地提供缩放、打开文件、打印、下载、旋转、文本选择与搜索等能力,并支持工具栏按区域定制与主题切换。
安装
sh
pnpm add @neosjs/pdf-viewersh
npm i @neosjs/pdf-viewersh
yarn add @neosjs/pdf-viewer快速上手
需要 Vue 3(peerDependency)。引入组件时记得同时引入样式文件:
vue
<script lang="ts" setup>
import PdfViewer from '@neosjs/pdf-viewer'
import { ref } from 'vue'
import '@neosjs/pdf-viewer/dist/index.css'
const pdf = ref('xxxxxx.pdf') // PDF 文件的 URL
const theme = ref('dark') // 主题颜色
const config = ref({
secondaryToolbar: false, // 是否显示次要工具栏
sidebar: false, // 是否显示侧边栏
toolbar: {
toolbarViewerLeft: { // 左侧工具栏,不需要时可以设置为 false
findbar: true, // 搜索
previous: true, // 上一页
next: true, // 下一页
pageNumber: true // 页码
},
toolbarViewerMiddle: { // 中间工具栏,不需要时可以设置为 false
zoomOut: true, // 缩小
zoomIn: true, // 放大
scaleSelectContainer: false // 缩放选择
},
toolbarViewerRight: { // 右侧工具栏,不需要时可以设置为 false
presentationMode: true, // 演示模式
openFile: true, // 打开文件
print: true, // 打印
download: true // 下载
}
}
})
</script>
<template>
<PdfViewer
:pdf="pdf"
:page-number="1"
:config="config"
file-name="PDF 的名字"
:theme="theme"
style="position: relative"
/>
</template>API
Props
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
pdf | string | — | PDF 文件的 URL |
page-number | number | 1 | PDF 的初始页码 |
page-scale | number | 1 | PDF 的缩放值 |
config | object | — | PDF 的配置项,见快速上手示例 |
file-name | string | — | PDF 的名字 |
theme | string | dark | 主题颜色 |
Events
| 名称 | 说明 |
|---|---|
after-created | PDF 创建完成 |
open | PDF 打开完成 |
pages-rendered | PDF 渲染完成 |
update-theme | 主题颜色更新 |