Cordova Document Viewer 插件使用教程

Cordova Document Viewer 插件使用教程

cordova-plugin-document-viewer A Document Viewer cordova/phonegap plugin for iOS, Android and Windows 项目地址: https://gitcode.com/gh_mirrors/co/cordova-plugin-document-viewer

1. 项目的目录结构及介绍

cordova-plugin-document-viewer/
├── src/
│   ├── android/
│   ├── ios/
│   ├── windows/
│   └── www/
├── www/
│   └── DocumentViewer.js
├── plugin.xml
├── package.json
└── README.md

• src/: 包含插件的源代码，按平台分为 android, ios, 和 windows 子目录。
• www/: 包含插件的 JavaScript 接口文件 DocumentViewer.js。
• plugin.xml: 插件的配置文件，定义了插件的元数据、依赖关系和文件路径。
• package.json: 插件的 npm 包配置文件，包含插件的版本、依赖等信息。
• README.md: 插件的说明文档，通常包含安装和使用说明。

2. 项目的启动文件介绍

插件的启动文件主要是 www/DocumentViewer.js，该文件定义了插件的 JavaScript 接口，提供了与原生代码交互的方法。开发者可以通过调用这些方法来实现文档的查看功能。

// www/DocumentViewer.js
var exec = require('cordova/exec');

var DocumentViewer = {
    viewDocument: function(url, contentType, options, onSuccess, onError) {
        exec(onSuccess, onError, "SitewaertsDocumentViewer", "viewDocument", [url, contentType, options]);
    }
};

module.exports = DocumentViewer;

3. 项目的配置文件介绍

plugin.xml

plugin.xml 是 Cordova 插件的配置文件，定义了插件的元数据、依赖关系和文件路径。以下是该文件的部分内容：

<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="cordova-plugin-document-viewer"
        version="1.0.0">
    <name>Document Viewer</name>
    <description>Cordova plugin to view documents.</description>
    <license>MIT</license>

    <js-module src="www/DocumentViewer.js" name="DocumentViewer">
        <clobbers target="cordova.plugins.SitewaertsDocumentViewer" />
    </js-module>

    <platform name="android">
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="SitewaertsDocumentViewer">
                <param name="android-package" value="de.sitewaerts.cordova.documentviewer.DocumentViewer"/>
            </feature>
        </config-file>
        <source-file src="src/android/DocumentViewer.java" target-dir="src/de/sitewaerts/cordova/documentviewer"/>
    </platform>

    <platform name="ios">
        <config-file target="config.xml" parent="/*">
            <feature name="SitewaertsDocumentViewer">
                <param name="ios-package" value="SitewaertsDocumentViewer"/>
            </feature>
        </config-file>
        <source-file src="src/ios/SitewaertsDocumentViewer.m" />
    </platform>
</plugin>

package.json

package.json 是 npm 包的配置文件，包含插件的版本、依赖等信息。以下是该文件的部分内容：

{
  "name": "cordova-plugin-document-viewer",
  "version": "1.0.0",
  "description": "Cordova plugin to view documents.",
  "cordova": {
    "id": "cordova-plugin-document-viewer",
    "platforms": [
      "android",
      "ios",
      "windows"
    ]
  },
  "keywords": [
    "cordova",
    "document",
    "viewer",
    "ecosystem:cordova",
    "cordova-android",
    "cordova-ios",
    "cordova-windows"
  ],
  "author": "sitewaerts GmbH",
  "license": "MIT"
}

通过以上配置文件，开发者可以了解插件的基本信息、依赖关系以及如何在不同平台上使用该插件。

cordova-plugin-document-viewer A Document Viewer cordova/phonegap plugin for iOS, Android and Windows 项目地址: https://gitcode.com/gh_mirrors/co/cordova-plugin-document-viewer