最详细的ionic cordova 插件配置文件 Plugin.xml 注解

PS:目前利用前端技术开发跨平台App很火爆,最火的当属使用cordova框架开发App,另外最近很火的前端开发框架ionic访问原生的能力也是来自于cordova(对cordova进行了封装)。插件是它们的核心所在,无论我们要使用ionic还是直接使用cordova去开发一个App,都会用到框架提供的插件或自定义插件,所以掌握Plugin.xml的编写还是很重要滴~。

plugin.xml文件作用

plugin.xml文件定义插件所需的结构和设置,它通过几个元素来提供有关插件的详细信息。

cordova Plugin.xml 官网
现在开始详细说一下这些元素(标签)~~~

顶级元素plugin

该plugin元素是插件清单的顶级元素。

属性(类型) 描述
xmlns(string) 必需的,插件命名空间http://apache.org/cordova/ns/plugins/1.0。如果文档包含来自其他命名空间的XML,例如AndroidManifest.xml在Android的情况下要添加到文件中的标记,那么这些命名空间也应该包含在元素中。
id(string) 必需的,插件的npm样式标识符。
version(string) 必需的, 插件的版本号。支持Semver语法。

例:


engines and engine

plugin元素的子元素指定此插件支持的基于Apache Cordova的框架的版本。对于目标项目不满足引擎约束的任何插件,CLI将使用非零代码进行中止。如果不指定了标记,则CLI会尝试盲目地安装到指定的cordova项目目录中。

注意:在Cordova 6.1.0+中,指定平台,插件和CLI依赖项的推荐位置在插件的package.json中。有关 更多信息,请参阅指定Cordova依赖项。

属性(类型) 描述
name(string) Required, 引擎名称。以下是支持的默认引擎:cordova; cordova-plugman;cordova-android; cordova-ios; cordova-windows; cordova-osx; windows-os; android-sdk (返回安装的最高Android api级别); windows-sdk (返回本机Windows SDK版本); apple-xcode (返回xcode版本); apple-ios (返回安装的最高iOS版本); apple-osx (返回OSX版本)。除默认框架外,您还可以指定自定义框架。
version(string) Required,您的框架必须具有的版本才能安装。支持Semver语法。
scriptSrc(string) *仅适用于自定义框架 *, Required ,此脚本文件告诉plugman自定义框架的版本。理想情况下,此文件应位于插件目录的顶级目录中。
platform(string) 仅适用于自定义框架 Required ,您的框架支持的平台。您可以使用通配符*来表示支持所有平台,使用管道字符指定多个,如`android。

例如:


  

引擎元素还可以使用“>”,“> =”等指定模糊匹配以避免重复,并在更新基础平台时减少维护。


  

标签默认支持所有的已经存在的主要的cordova平台。指定cordova引擎标记意味着任何平台上的所有Cordova版本都必须满足引擎版本属性。您还可以列出特定平台及其版本,以覆盖笼统的cordova引擎:


  
  
  

自定义框架的例子:

  
  
  

name

该name元素用于指定插件的名称。此元素(尚未)处理本地化。
例如:

 Foo

description

该description元素用于指定插件的描述。此元素(尚未)处理本地化。
例如:

Foo plugin description

author

author元素的内容包含插件作者的名称。

例如:

Foo plugin author

keywords

keywords元素的内容包含逗号分隔的关键字以描述插件。

例子:

foo,bar

license(许可、执照)

此元素用于指定插件的许可证。
例如:

Apache 2.0 License

asset

此元素用于列出要复制到Cordova应用程序www目录中的文件或目录。任何嵌套在元素中的元素都指定特定于平台的web资源。

属性(类型) 描述
src(string) Required,相对于plugin.xml文档,文件或目录位于插件包中的位置。如果指定的src位置不存在文件,CLI将停止并撤消安装过程,发出有关冲突的通知,并使用非零代码退出。
target(string) Required,文件或目录应位于Cordova应用程序中相对于www目录的位置。如果目标位置已存在文件,CLI将停止并撤消安装过程,发出有关冲突的通知,并以非零代码退出。

例子:





资源也可以指定到子目录。这将在www目录中创建js/experimental目录,除非已存在,并复制该new-foo.js文件并将其重命名为foo.js。


js-module

大多数插件都包含一个或多个JavaScript文件。每个标记对应一个JavaScript文件,并阻止插件的使用者必须为每个文件添加

你可能感兴趣的:(最详细的ionic cordova 插件配置文件 Plugin.xml 注解)