Cordova Document Viewer 插件使用教程

Cordova Document Viewer 插件使用教程

1. 项目介绍

cordova-plugin-document-viewer 是一个用于 Cordova/Phonegap 应用的文档查看器插件，支持 iOS、Android 和 Windows 平台。该插件允许开发者在应用中嵌入一个高性能且安全的内联查看器，用于查看 PDF 文件。它提供了对 PDF 文件的本地查看功能，避免了使用外部应用查看文件时可能导致的文件泄露问题。

2. 项目快速启动

安装插件

你可以通过以下命令从 GitHub 仓库安装插件：

cordova plugin add https://github.com/sitewaerts/cordova-plugin-document-viewer.git

或者从 npm 安装：

cordova plugin add cordova-plugin-document-viewer

使用插件

在 Cordova 项目中，确保在 deviceready 事件触发后使用插件。以下是一个简单的示例代码：

document.addEventListener('deviceready', function () {
    var url = 'file:///path/to/your/document.pdf';
    var mimeType = 'application/pdf';
    var options = {
        title: 'My Document',
        documentView: {
            closeLabel: 'Close'
        },
        navigationView: {
            closeLabel: 'Back'
        },
        email: {
            enabled: true
        },
        print: {
            enabled: true
        },
        openWith: {
            enabled: false
        },
        bookmarks: {
            enabled: true
        },
        search: {
            enabled: true
        },
        autoClose: {
            onPause: true
        }
    };

    cordova.plugins.SitewaertsDocumentViewer.viewDocument(
        url,
        mimeType,
        options,
        function () {
            console.log('Document shown');
        },
        function () {
            console.log('Document closed');
        },
        function (appId, installer) {
            if (confirm("Do you want to install the free PDF Viewer App " + appId + " for Android?")) {
                installer();
            }
        },
        function (error) {
            console.log(error);
            alert("Sorry, Cannot view document");
        }
    );
}, false);

3. 应用案例和最佳实践

应用案例

• 企业内部文档查看：在企业内部应用中，使用该插件可以安全地查看和分发文档，避免文档泄露。
• 教育应用：在教育类应用中，学生可以通过该插件查看课程资料和作业。
• 电子书阅读器：在电子书阅读器应用中，用户可以查看 PDF 格式的电子书。

最佳实践

• 安全性：确保文档路径和 MIME 类型正确，避免用户访问到不应访问的文件。
• 用户体验：根据应用需求配置查看器的选项，如是否允许打印、发送邮件等。
• 错误处理：在插件调用中添加错误处理函数，确保应用在遇到问题时能够给出友好的提示。

4. 典型生态项目

• Cordova File Plugin：该插件通常与 cordova-plugin-file 一起使用，以便从应用的文件系统中读取文档。
• Ionic Native Wrapper：如果你使用 Ionic 框架，可以使用 Ionic Native 提供的封装来简化插件的使用。
• PDF.js：对于需要跨平台支持的 PDF 查看功能，可以考虑使用 pdf.js，它是一个基于 Web 的 PDF 查看器。

通过以上步骤，你可以快速上手并使用 cordova-plugin-document-viewer 插件，为你的 Cordova 应用添加强大的文档查看功能。