@fiscozen/pdf-viewer

中文文档
1.0.15发布于 2026/10/23MITES Module近 30 天下载 2301

设计系统 PdfViewer 组件

中文使用文档
文档目录9 节
  1. 安装
  2. 使用量
  3. 道具
  4. v 型号
  5. 活动
  6. 实例
  7. 基本工具栏
  8. 带有下载的高级工具栏
  9. PDF/ XML 切换

@fiscozen/pdf-查看器

Vue 3 组件,用于渲染带有缩放,页面导航,以及可选 PDF/XML 视图模式切换等功能的PDF文件.

安装

npm install @fiscozen/pdf-viewer

使用量

<script setup>
import { FzPdfViewer } from '@fiscozen/pdf-viewer'
</script>

<template>
  <FzPdfViewer src="https://example.com/document.pdf" width="100%" />
</template>

道具

Prop类型默认说明
srcstring—— 说要求. PDF 文件的 URL.
xmlSrcstring—— 说XML 文件的 URL. 提供时 toolbarVariant="advanced",允许 PDF/XML 视图模式切换。 在XML模式下,以iframe提供XML,并隐藏缩放/页面控制.
environment"frontoffice" | "backoffice""frontoffice"大小环境变体.
heightstring"768px"取景器容器高度.
widthstring"512px"取景器容器的宽度.
toolbarVariant"basic" | "advanced""basic""basic" 显示缩放和页面导航. "advanced" 添加下载按钮, 当 xmlSrc 提供了 PDF/XML 视图模式切换.
toolbarPosition"top" | "bottom""bottom"工具栏相对于 PDF 的位置 。 何时 "top",工具栏只在悬浮时显示.
initialPagenumber1开始页面.
initialScalenumber1开始缩放级别(1=100%).
minScalenumber0.25最小缩放级别 .
maxScalenumber2最大缩放级别 .
scaleStepnumber0.25每步放大增量.
selectablebooleanfalse何时 true,使文本层允许用户选择并复制文本.
rotatablebooleanfalse何时 true,在高级工具栏中显示旋转按钮。 仅适用于下列情况: toolbarVariant="advanced"。 。 。 .
containerClassstring—— 说外容器自定义 CSS 类 .
pdfContainerClassstring—— 说PDF/内容容器自定义 CSS 类 .

v 型号

型号类型默认说明
viewMode"pdf" | "xml""pdf"当前视图模式 。 只有活动时 toolbarVariant="advanced" 财务报告和审定财务报表 xmlSrc 提供.

活动

活动有效载荷说明
download—— 说点击下载按钮时发送 。 家长负责处理实际下载(例如根据当前下载PDF或XML) viewMode) (中文(简体) ).

实例

基本工具栏

<FzPdfViewer
  src="https://example.com/document.pdf"
  width="100%"
/>

带有下载的高级工具栏

<FzPdfViewer
  src="https://example.com/document.pdf"
  toolbarVariant="advanced"
  width="100%"
  @download="handleDownload"
/>

PDF/ XML 切换

何时 xmlSrc 将同时提供 toolbarVariant="advanced",组件显示一个可切换 PDF 视图和 XML 视图的标签切换器。 在 XML 模式下, XML 在 iframe 中渲染出; 缩放和页控件在下载按钮仍然可见时被隐藏.

<script setup>
import { ref } from 'vue'
import { FzPdfViewer } from '@fiscozen/pdf-viewer'

const viewMode = ref('pdf')

function handleDownload() {
  const url = viewMode.value === 'pdf' ? pdfUrl : xmlUrl
  // trigger download...
}
</script>

<template>
  <FzPdfViewer
    src="https://example.com/document.pdf"
    xmlSrc="https://example.com/document.xml"
    toolbarVariant="advanced"
    v-model:viewMode="viewMode"
    width="100%"
    @download="handleDownload"
  />
</template>

说明: 这个 download 事件不会自动下载任何东西。 使用 viewMode 以确定是下载PDF还是XML.

版本与发布记录

@fiscozen/pdf-viewer 共发布 23 个版本,首次发布于 2024/12/13;过去 12 个月发布了 21 个版本。

版本发布日期距今
1.0.15latest2026/10/2323 天前
1.0.142026/10/2026 天前
1.0.132026/10/141 个月前
1.0.122026/10/071 个月前
1.0.112026/09/291 个月前
1.0.102026/09/142 个月前

关于 @fiscozen/pdf-viewer 的常见问题

@fiscozen/pdf-viewer 是什么?

设计系统 PdfViewer 组件

如何安装 @fiscozen/pdf-viewer?

在项目目录运行 npm install @fiscozen/pdf-viewer,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(^3.4.13)、tailwindcss(^3.4.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fiscozen/pdf-viewer 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/fiscozen__pdf-viewer 是否存在。

@fiscozen/pdf-viewer 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fiscozen/pdf-viewer 可以商用吗?

@fiscozen/pdf-viewer 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fiscozen/pdf-viewer 的下载量有多少?

根据 npm 官方下载统计,@fiscozen/pdf-viewer 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,301 次,日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fiscozen/pdf-viewer 还在维护吗?

最新版本 1.0.15 发布于 2026/10/23(23 天前);至今共发布 23 个版本,其中过去 12 个月发布了 21 个;首次发布于 2024/12/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。