Flyfish Viewer

English

简体中文

English

简体中文

Appearance

Vue2 集成 ​

For Vue 2 Projects

Vue2 已拆成 @file-viewer/vue2.7 和 @file-viewer/vue2.6 两条标准包线。 它们面向仍在 Vue2 的业务系统，格式能力、示例文件和 options / 事件语义与 Vue3 包保持一致。

安装 ​

bash
pnpm add @file-viewer/vue2.7 @file-viewer/preset-office

Vue2.6 项目请安装:

bash
pnpm add @file-viewer/vue2.6 @file-viewer/preset-office

只安装 @file-viewer/vue2.7 或 @file-viewer/vue2.6 是最轻组件入口；PDF、Office、CAD、Typst、压缩包等具体格式能力由 preset 或 renderer 提供。Webpack、Rspack、Rollup、Umi、传统多页应用等非 Vite 项目优先通过 options.preset 显式注入能力：

ts
import officePreset from '@file-viewer/preset-office'

const viewerOptions = {
  preset: officePreset,
  rendererMode: 'replace',
  theme: 'light',
  styleIsolation: 'shadow',
  toolbar: { position: 'bottom-right' }
}

宿主页面有强全局 CSS、低代码 reset 或微前端样式串扰时，推荐传 styleIsolation:'shadow'。Vue2 包默认保持历史兼容；完整隔离模式、tokens 和 ::part() 定制见 样式隔离与主题定制。

Vite 项目可以额外加入插件，插件会自动发现已安装的 @file-viewer/preset-* 并省去手动 import preset。注意：只安装插件包不会让 Vite 自动运行，仍需要在 vite.config.ts 注册一次插件：

bash
pnpm add -D @file-viewer/vite-plugin
ts
import { defineConfig } from 'vite'
import { fileViewerRenderers } from '@file-viewer/vite-plugin'

export default defineConfig({
  plugins: [
    fileViewerRenderers({
      copyAssets: true
    })
  ]
})

需要完整格式矩阵时，把 @file-viewer/preset-office 换成 @file-viewer/preset-all，Vite 配置保持一致：

bash
pnpm add @file-viewer/vue2.7 @file-viewer/preset-all

也可以使用 full 包一步到位：Vue2.7 使用 @file-viewer/vue2.7-full，Vue2.6 使用 @file-viewer/vue2.6-full。full 包默认启用完整格式矩阵，组件、事件和 controller API 与标准包一致：

bash
pnpm add @file-viewer/vue2.7-full
ts
import Vue from 'vue'
import FileViewer from '@file-viewer/vue2.7-full'

Vue.use(FileViewer)

如果是 Vue 2.6 项目，把组件包替换为 @file-viewer/vue2.6 或 @file-viewer/vue2.6-full 即可。需要更强自定义时，再配置 formats、renderers、scan:true、inject:false 或 chunkStrategy:'renderer'；常规项目保持 fileViewerRenderers({ copyAssets:true }) 即可。

Vue 2.6 + Vue CLI 3 / webpack 4 ​

如果旧项目里“只要导入 @file-viewer/preset-office 就报错，注释掉就不报错”，通常不是 Vue2.6 组件失效，而是 preset-office 会把 PDF、Word、Excel、PPTX、OFD 等 renderer 依赖链一起纳入构建；Vue CLI 3 的 webpack 4 默认不转译 node_modules，也不理解部分 package exports 子路径和 import.meta.url worker 写法。

仓库提供了一个独立可运行示例，技术栈按客户常见后台项目抽取：vue@2.6、@vue/cli-service@3.1、webpack 4、Element UI、Ant Design Vue 1.x、babel-polyfill 和 @file-viewer/preset-office。

bash
cd examples/vue2.6-cli3-office
npm install
npm run serve

Node 17+ 跑 webpack 4 时，如果遇到 OpenSSL/MD4 报错，可以临时加：

bash
NODE_OPTIONS=--openssl-legacy-provider npm run build

客户项目里优先整份参考示例的 vue.config.js，至少需要搬这几类配置：

js
// vue.config.js
const path = require('path')

const resolveApp = value => path.resolve(__dirname, value)
const resolvePackageRoot = packageName => path.dirname(require.resolve(`${packageName}/package.json`))
const resolvePackageFile = (packageName, relativePath) => path.join(resolvePackageRoot(packageName), relativePath)

module.exports = {
  transpileDependencies: [
    /@file-viewer/,
    /pdfjs-dist/,
    /e-virt-table/,
    /styled-exceljs/
  ],
  configureWebpack: {
    resolve: {
      alias: {
        '@file-viewer/core/assets$': resolvePackageFile('@file-viewer/core', 'dist/assets.js'),
        '@file-viewer/core/browser$': resolvePackageFile('@file-viewer/core', 'dist/browser.js'),
        '@file-viewer/core/headless$': resolvePackageFile('@file-viewer/core', 'dist/headless.js')
      },
      extensions: ['.mjs', '.js', '.vue', '.json']
    }
  }
}

示例还包含两个 webpack 4 兼容补丁：build/rename-pdfjs-webpack-require.cjs 会处理 PDF.js legacy .mjs 自带 webpack 包装代码，避免和宿主 webpack 4 注入的 __webpack_require__ 同名冲突；build/babel-transform-import-meta-url.cjs 负责让 webpack 4 解析 PPTX worker 模块。scripts/copy-file-viewer-assets.cjs 会把 PDF/DOCX/PPTX/Excel 的 worker、CMap、WASM 和字体复制到 public/file-viewer/。

npm run serve 对应的 .env.normalServe 使用 NODE_ENV=production，是为了避开 Vue CLI 3.1 dev server 对 HMR 客户端的强注入；真实项目可以先用这个模式确认 preset-office 构建链可用，再决定是否保留热更新。

业务代码里继续通过 options.preset 注入能力，同时把离线资产路径显式传进去：

js
import officePreset from '@file-viewer/preset-office'

const assetBaseUrl = './file-viewer/'

export const viewerOptions = {
  preset: officePreset,
  rendererMode: 'replace',
  theme: 'light',
  styleIsolation: 'shadow',
  pdf: {
    workerUrl: `${assetBaseUrl}vendor/pdf/pdf.worker.mjs`,
    cMapUrl: `${assetBaseUrl}vendor/pdf/cmaps/`,
    wasmUrl: `${assetBaseUrl}vendor/pdf/wasm/`,
    standardFontDataUrl: `${assetBaseUrl}vendor/pdf/standard_fonts/`
  },
  docx: {
    workerUrl: `${assetBaseUrl}vendor/docx/docx.worker.js`,
    workerJsZipUrl: `${assetBaseUrl}vendor/docx/jszip.min.js`
  },
  presentation: {
    workerUrl: `${assetBaseUrl}vendor/pptx/pptx.worker.js`
  },
  spreadsheet: {
    workerUrl: `${assetBaseUrl}vendor/xlsx/sheet.worker.js`
  }
}

Vue CLI 3 / webpack 4 可以继续使用这条接入路径，但建议面向现代浏览器构建；如果项目仍强依赖 IE11 或旧版 uglifyjs-webpack-plugin 压缩全量 Office 依赖链，优先考虑升级压缩器、升级构建链，或改用 @file-viewer/vue2.6-full / Web Component IIFE 形态做边界隔离。

注册插件 ​

ts
import Vue from 'vue'
import App from './App.vue'
import FileViewer from '@file-viewer/vue2.7'

Vue.use(FileViewer)

new Vue({
  render: h => h(App)
}).$mount('#app')

Vue2 入口会自动带上样式，不需要再额外 import CSS。

URL 预览 ​

vue
<template>
  <div style="height: 100vh">
    <file-viewer :url="url" :options="options" />
  </div>
</template>

<script>
import officePreset from '@file-viewer/preset-office'

export default {
  data() {
    return {
      url: 'https://example.com/demo.pdf',
      options: {
        theme: 'light',
        preset: officePreset,
        rendererMode: 'replace',
        toolbar: { position: 'bottom-right' },
        watermark: { text: '内部预览', opacity: 0.14 },
        archive: {
          cache: true,
          workerTimeoutMs: 30000
        }
      }
    }
  }
}
</script>

File 预览 ​

vue
<template>
  <div style="height: 100vh">
    <input type="file" @change="onChange" />
    <div style="height: calc(100vh - 40px)">
      <file-viewer :file="file" />
    </div>
  </div>
</template>

<script>
export default {
  data() {
    return {
      file: undefined
    }
  },
  methods: {
    onChange(event) {
      const value = event.target.files && event.target.files.item(0)
      if (value) {
        this.file = value
      }
    }
  }
}
</script>

与其他生态版本保持一致 ​

Vue2.7 / Vue2.6 标准包共享同一套 core 接口和 renderer/preset 装配能力；完整矩阵可覆盖 Word、Excel、PPT、PDF、OFD、Typst、XMind 脑图、压缩包、邮件、OLB/DRA/GDS/OASIS、CAD、地理数据、3D 模型、Excalidraw、draw.io、EPUB、UMD、Markdown、代码高亮、图片、音视频、字体、设计资产和结构化数据。差异主要在包名和 Vue 运行时版本:

两条分支也共享同一套打印和缩放能力判断: toolbar.print / toolbar.zoom 只表示业务是否显示按钮，真实按钮会结合当前文件类型、渲染完成状态、导出适配器和缩放 provider 动态显隐。toolbar.position 支持 auto、top、top-center、bottom-right，默认 auto，PDF 会自动悬浮到右下角以避开自身导航栏；需要顶部水平居中时传 top-center。Word / PDF 会输出完整页面，不适合直接打印的表格、压缩包、邮件、EPUB、音视频、3D / 模型等链路会隐藏打印按钮；Excel 等虚拟表格不会被外层 CSS 强行缩放。options.theme 支持 light、dark、system，默认继续跟随系统；浅色业务系统建议显式传 light。

版本npm 包最新版本注册方式
Vue2.7@file-viewer/vue2.7latestVue.use(FileViewer)
Vue2.6@file-viewer/vue2.6latestVue.use(FileViewer)
Vue2.7 Full@file-viewer/vue2.7-fulllatest默认启用完整格式矩阵
Vue2.6 Full@file-viewer/vue2.6-fulllatest默认启用完整格式矩阵
Vue3@file-viewer/vue3latestcreateApp(App).use(FileViewer)

历史包名 @flyfish-group/file-viewer 仍同步维护，对应 Vue2.7 线；新项目建议优先使用标准包名。

如果一个预览能力需要被多个不同技术栈系统复用，建议统一使用标准组件包线，让 Vanilla JS / Pure Web、Vue、React、jQuery 和 Svelte 共享同一套 core 能力和运行参数。完整矩阵见 生态组件总览。

Released under the Apache-2.0 License.

Copyright © 2026 Flyfish Viewer