README.md

@sinoui/pdf-viewer

基于react-pdf的 pdf 预览。

基本使用

import PdfViewer from '@sinoui/pdf-viewer';
import testFilePath from './test.pdf';

<PdfViewer url={testFilePath} title="xxx.pdf" />;

PdfViewer 属性列表

属性名称	属性类型	属性说明
url	string	指定文件路径
creator	string	文件编辑人
title	string	文件标题
annotationsStore	{get: () => Promise<any>; save: (annotations: PdfAnnotationType[]) =>Promise<any> };	自定义存储方式

批注存储

批注信息默认存储在localStorage中,如果需要与后端交互，则需要通过annotationsStore属性指定存储方式，具体如下：

const annotationsStore = {
  async get() {
    return await http.get(`/apis/pdf-annotations/${fileId}`);
  },
  async save(annotations) {
    return await http.post(`/apis/pdf-annotations/${fileId}`, annotations);
  },
};

<PdfViewer
  url={testFilePath}
  creator="张三"
  annotationsStore={annotationsStore}
/>;

优化

在 webpack 中使用

在 webpack 中使用 pdf-viewer，往往会导致开发与编译缓慢。这是因为 pdf.js 代码量特别大，推荐的做法是采用 webpack exnternals，直接加载 pdf.js 的包，而不经过 webpack 打包处理。具体做法如下所示。

直接拷贝 pdfjs 文件

可以通过 copy-webpack-plugin，将 node_modules/pdfjs-dist 中的 js 文件拷贝到包中。

安装 copy-webpack-plugin:

yarn add copy-webpack-plugin --dev

在 webpack 的配置文件中添加以下配置：

const CopyPlugin = require('copy-webpack-plugin');

const config = {
  plugins: [
    new CopyPlugin({
      patterns: [
        {
          from: resolve(__dirname, 'node_modules/pdfjs-dist/build/pdf.min.js'),
          to: 'static',
        },
        {
          from: resolve(
            __dirname,
            'node_modules/pdfjs-dist/build/pdf.worker.min.js',
          ),
          to: 'static',
        },
        {
          from: resolve(__dirname, 'node_modules/pdfjs-dist/web/pdf_viewer.js'),
          to: 'static',
        },
      ],
    }),
  ],
};

配置外部扩展

将 pdfjs-dist 配置为 外部扩展：

const config = {
  externals: {
    'pdfjs-dist': 'pdfjsLib',
    'pdfjs-dist/lib/web/pdf_link_service': 'pdfjsViewer',
  },
};

使用 @sinoui/pdf-viewer/dynamic 组件

@sinoui/pdf-viewer/dynamic 提供了便捷的动态加载 pdf.js 脚本的组件，用法与PdfViewer 一致，与如下所示：

import PdfViewerDynamic from '@sinoui/pdf-viewer/dynamic';

function PdfViewerDemo() {
  return (
    <PdfViewerDynamic
      publicPath="/static"
      url="/test.pdf"
      loading={<div>正在准备pdf阅读器</div>}
    />
  );
}

publicPath 可以与 webpack 中的 process.env.PUBLIC_PATH 组合使用：

import PdfViewerDynamic from '@sinoui/pdf-viewer/dynamic';

function PdfViewerDemo() {
  return (
    <PdfViewerDynamic
      publicPath={process.env.PUBLIC_PATH}
      url="/test.pdf"
      loading={<div>正在准备pdf阅读器</div>}
    />
  );
}

与 storybook 组合使用

需要在 .storybook/webpack.config.js 中添加类似上文提出的配置。如下所示：

const { resolve } = require('path');
const CopyPlugin = require('copy-webpack-plugin');

module.exports = ({ config }) => {
  config.resolve.extensions.push('.ts', '.tsx');
  config.resolve.alias = {
    '@sinoui/pdf-viewer': resolve(__dirname, '../src'),
  };

  config.plugins.push(
    new CopyPlugin({
      patterns: [
        {
          from: resolve(
            __dirname,
            '../node_modules/pdfjs-dist/build/pdf.min.js',
          ),
          to: 'static',
        },
        {
          from: resolve(
            __dirname,
            '../node_modules/pdfjs-dist/build/pdf.worker.min.js',
          ),
          to: 'static',
        },
        {
          from: resolve(
            __dirname,
            '../node_modules/pdfjs-dist/web/pdf_viewer.js',
          ),
          to: 'static',
        },
      ],
    }),
  );

  config.externals = {
    'pdfjs-dist': 'pdfjsLib',
    'pdfjs-dist/lib/web/pdf_link_service': 'pdfjsViewer',
  };

  return config;
};

显示中文

为了更好的中文排版效果，需要加载 pdfjs-dist 的 cMaps，在 webpack 打包时拷贝 cMaps 文件：

const CopyPlugin = require('copy-webpack-plugin');

config.plugins.push(
  new CopyPlugin({
    patterns: [
      {
        from: 'node_modules/pdfjs-dist/cmaps/',
        to: 'cmaps/',
      },
    ],
  }),
);

使用组件时添加额外的配置：

<PdfViewer
  options={{
    cMapUrl: '/cmaps/',
    cMapPacked: true,
  }}
/>

本地开发

项目中有以下有用的命令。

yarn build

打包，并将打包文件放在dist文件夹中。使用 rollup 对代码做优化并打包成多种格式（Common JS，UMD和ES Module）。

yarn lint

yarn lint会检查整个项目是否有代码错误、风格错误。

开启 vscode 的 eslint、prettier 插件，在使用 vscode 编码时，就会自动修正风格错误、提示语法错误。

yarn format

yarn format可以自动调整整个项目的代码风格问题。

yarn test

yarn test以监听模式启动 jest，运行单元测试。

开启 vscode 的 jest 插件，会在文件变化时自动运行单元测试。

yarn release

发布 npm 包的命令。