WeX5的混合模式底层基于cordova/phonegap,所以开发本地插件只需要按照相应规范就可以,由于BeX5基于WeX5,所以本文档也适用于BeX5。
一、如何使用本地插件(Cordova plugin)
在需要使用插件的页面对应的js中,如下代码引用:
require("$UI/system/lib/cordova/cordova"); //cordova运行环境,多个页面用cordova插件,每个页面都需要require进来 require("cordova!phonegap-plugin-barcodescanner"); //使用的cordova插件
再参考插件的文档,书写对应的js。例如二维码插件barcodesacnner,代码如下:
//扫描二维码,返回二维码信息 cordova.plugins.barcodeScanner.scan( function (result) { alert("We got a barcoden" + "Result: " + result.text + "n" + "Format: " + result.format + "n" + "Cancelled: " + result.cancelled); }, function (error) { alert("Scanning failed: " + error); } );
二、插件列表见下表
其中:
“所在位置”为studio.exe(也就是IDE工具中)“Native/plugins”文件夹下;
“调用名称”为JS调用时使用到的名称;
“参数”,如果需要参数,那么在打包为APP应用的时候,需要进行参数的填写;
“案例路径”,为studio.exe(也就是IDE工具中)具体案例所在路径。
注意:
1、插件相关说明,均在对应插件“所在位置”目录下的xdoc文件中,详细使用方法请参考对应文档。
插件名称 | 功能描述 | 详情 |
---|---|---|
支付宝支付
|
阿里支付本地扩展插件 | 所在位置:com.justep.cordova.plugin.alipay
调用名称:navigator.alipay 参数:需要 案例路径:/UI2/takeout |
银联支付 | 银联支付本地扩展插件 | 所在位置:com.justep.cordova.plugin.unionpay
调用名称:navigator.unionpay 参数:需要 案例路径:/UI2/takeout |
微信支付(分享) | 微信v3本地扩展插件,包括微信支付和微信分享 | 所在位置:com.justep.cordova.plugin.weixin.v3
调用名称:navigator.weixin 参数:需要 支付案例路径:/UI2/takeout ; 分享案例路径:/UI2/demo/native/share |
下载插件 | 下载多个或单个文件,可以进行校验的一致性或下载完成自动解压文件 | 所在位置:cordova-plugin-fastrde-downloader
调用名称:window.downloader 案例路径:/UI2/demo/native/downloader |
本地文件插件 (使用方法) | 本地文件插件,提供对本地文件的存取操作,该插件基于html5的File | 所在位置:cordova-plugin-file
调用名称:window.File 案例路径:/UI2/demo/native/downloader |
文件打开插件 | 在app中使用默认打开方式打开本地文件 | 所在位置:cordova-plugin-file-opener2
调用名称:cordova.plugins.fileOpener2 案例路径:/UI2/demo/native/fileOpener |
本地文件传输 | 本地文件传输插件,提供文件的上传下载操作 | 所在位置:cordova-plugin-file-transfer
调用名称:window.FileTransfer 案例路径:/UI2/system/api/native |
文件打开 | 在app中用打开音频,视频,图片或其他格式的文件等,支持本地文件和远程文件 | 所在位置:cordova-open
调用名称:cordova.plugins.disusered 案例路径:/UI2/demo/native/open |
打开文档插件 (使用方法) | 打开文档插件,下载指定url的文档并使用系统注册过的应用打开 | 所在位置:ch.ti8m.documenthandler
调用名称:window.handleDocumentWithURL |
md5校验 | 读取大文件并生成md5sum增量 | 所在位置:de.fastr.phonegap.plugins.md5chksum
调用名称:window.md5chksum |
极光推送 (使用方法) | 推送消息,支持Android,ISO | 所在位置:cn.jpush.phonegap.JPushPlugin
调用名称:window.plugins.jPushPlugin 参数:需要 案例路径:/UI2/takeout |
近场通讯 | 近场通讯插件,仅支持Android | 所在位置:phonegap-nfc
调用名称:window.nfc |
地理位置 (使用方法) | 地理位置位置插件,提供地理位置信息,依赖百度定位插件 | 所在位置:cordova-plugin-geolocation
调用名称:navigator.geolocation 案例路径:/UI2/demo/native/geolocation |
社交分享 | 分享插件,可分享文本、图片等文件,并关联打开本地注册过的可分享类型 | 所在位置:cordova-plugin-x-socialsharing
调用名称:plugins.socialsharing 案例路径:/UI2/demo/native/shareInfo |
二维码扫描 | 二维码、条形码扫描插件 | 所在位置:phonegap-plugin-barcodescanner
调用名称:cordova.plugins.barcodeScanner 案例路径:/UI2/demo/native/barcode |
视频播放插件 | 视频播放插件,支持本地路径和http://路径 | 所在位置:com.phonegap.plugins.videoplayer
调用名称:cordova.plugins.videoPlayer 案例路径:/UI2/demo/native/videoplayer |
状态栏 (使用方法) | 状态栏本地插件,用来控制状态栏的显示方式 | 所在位置:cordova-plugin-statusbar
调用名称:window.StatusBar 参数:需要 |
Http请求 (使用方法) | Http请求插件,使用本地接口发送http请求,这将提供跨域的ajax调用 | 所在位置:plugin.http.request
调用名称:navigator.plugins.HttpRequest 案例路径:/UI2/demo/netease |
内置浏览 | 内置浏览本地插件,类似浏览器中js的window.open,用指定模式打开url | 所在位置:cordova-plugin-inappbrowser
调用名称:window.open 案例路径:/UI2/demo/account |
蓝牙 | 蓝牙插件,提供对蓝牙设备的监听和使用 | 所在位置:cordova-plugin-ble-central
调用名称:window.ble |
照相机 | 照相机本地插件,调用照相机获取图片 | 所在位置:cordova-plugin-camera
调用名称:navigator.camera 案例路径:/UI2/demo/native/camera |
设备信息 (使用方法) | 设备信息本地插件,获取设备信息,包括操作系统类型和版本、设备uuid等 | 所在位置:cordova-plugin-device
调用名称:window.device |
设备传感器 | 加速器本地插件,获取设备加速器(acceleration)信息 | 所在位置:cordova-plugin-device-motion
调用名称:navigator.accelerometer 案例路径:/UI2/demo/native/accelerometer |
指南针 | 电子罗盘本地插件,获取设备方向信息 | 所在位置:cordova-plugin-device-orientation
调用名称:navigator.compass |
联系人 | 联系人本地插件,获取设备联系人信息 | 所在位置:cordova-plugin-contacts
调用名称: navigator.contacts |
声音设备 (使用方法) | 本地声音设备插件,用于播放声音、控制音量等 | 所在位置:cordova-plugin-media
调用名称:window.Media 案例路径:/UI2/demo/native/audio |
多媒体文件录制 | 多媒体录制本地插件,用于捕获图片、录制声音和视频 | 所在位置:cordova-plugin-media-capture
调用名称: navigator.device.capture 案例路径:/UI2/demo/native/camera |
电池状态 | 电池状态插件,监控设备电池状态 | 所在位置:cordova-plugin-battery-status
调用名称: navigator.battery |
屏幕旋转 (使用方法) | 控制屏幕旋转方向 | 所在位置:cordova-plugin-screen-orientation
调用名称:window.plugins.screen 案例路径:/UI2/demo/native/screenorientation |
屏幕常亮插件 (使用方法) | 使屏幕禁止睡眠 | 所在位置:cordova-plugin-insomnia
调用名称: plugins.insomnia |
设备震动 | 震动本地插件,调用设备进行震动 | 所在位置:cordova-plugin-vibration
调用名称:navigator.notification |
本地日历插件 (使用方法) | 用于调用本地日历,设置活动相关操作 | 所在位置:cordova-plugin-calendar
调用名称:plugins.calendar 案例路径:/UI2/demo/native/calendar |
本地浮动框提示 | 浮动提示插件,弹出本地浮动提示框 | 所在位置:cordova-plugin-x-toast
调用名称: plugins.toast 案例路径:/UI2/demo/native/toast |
本地等待和进度 (使用方法) | 基于Spinner提供的本地等待和进度对话框 | 所在位置:cordova-plugin-spinner-dialog
调用名称: plugins.spinnerDialog |
本地选项卡 (使用方法) | 本地选项卡插件,用来展示一组本地选项列表 | 所在位置:cordova-plugin-actionsheet
调用名称:plugins.actionsheet 案例路径:/UI2/demo/native/actionsheet |
本地对话框 | 本地对话框插件,提供提醒(alert)、询问(confirm, prompt)和蜂鸣音(beep)的本地调用 | 所在位置:cordova-plugin-dialogs
调用名称:navigator.notification |
SQLite插件 (使用方法) | SQLite插件,提供本地数据库的存储 | 所在位置:com.brodysoft.sqlitePlugin
调用名称:window.SQLitePlugin 案例路径:/UI2/demo/native/sqlite |
app缓存清除插件 | 清除app缓存 | 所在位置:at.modalog.cordova.plugin.cache
调用名称:window.cache 案例路径:/UI2/demo/native/clearCache |
应用安装状态 (使用方法) | 应用安装状态插件, 通过URI Scheme (iOS) 或者包名(Android)判断指定的应用是否已安装 | 所在位置:cordova-plugin-appavailability
调用名称: window.appAvailability |
app后台运行 | app后台运行插件,防止app在后台进入睡眠状态 | 所在位置:de.appplant.cordova.plugin.background-mode
调用名称:cordova.plugins.backgroundMode 案例路径:/UI2/demo/native/backgroundMode |
应用图标数字提醒 (使用方法) | 应用图标数字提醒。IOS通过应用图标数字进行提醒;Android系统由于系统限制,通过状态栏进行提醒 | 所在位置:de.appplant.cordova.plugin.badge
调用名称:plugin.notification.badge 案例路径:/UI2/demo/native/badge |
获取app版本信息 (使用方法) | 获取app版本相关信息 | 所在位置:cordova-plugin-app-version
调用名称: cordova.getAppVersion 案例路径:/UI2/demo/account |
闪屏插件 | 欢迎页本地插件,默认建议包含。启动本地应用时显示指定的图片 | 所在位置:cordova-plugin-splashscreen
调用名称: navigator.splashscreen |
国际化 | 国际化插件,提供语言、日期、货币等本地化信息 | 所在位置:cordova-plugin-globalization
调用名称:navigator.globalization |
本地转场动画 | 本地转场动画插件,提供页面间的本地转场动画效果 | 所在位置:com.telerik.plugins.nativepagetransitions
调用名称:plugins.nativepagetransitions 案例路径:/UI2/demo/native/barcode |
复制粘贴 | 复制粘贴文本 | 所在位置:com.verso.cordova.clipboard
调用名称:cordova.plugins.clipboard 案例路径:/UI2/demo/native/clipboard |
自定义URL协议 (使用方法) | 自定义指定的协议类型URL_SCHEME,并通过handleOpenURL回调进行接管。例如指定协议mycoolapp,则将接管mycoolapp://xxx | 所在位置:cordova-plugin-customurlscheme
调用名称:window.plugins.launchmyapp 参数:需要 |
console | 提供全局对象console,通过console.log()记录日志 | 所在位置:cordova-plugin-console
调用名称:window.console |
键盘插件 | 键盘插件,用来显示隐藏键盘及其他关于键盘的操作 | 所在位置:cordova-plugin-keyboard
调用名称:window.Keyboard 案例路径:/UI2/demo/native/keyboard |
网络信息 | 网络信息本地插件,获取网络连接信息 | 所在位置:cordova-plugin-network-information
调用名称:navigator.connection |
隐私屏幕 (使用方法) | 隐私屏幕插件,本插件无调用接口,包含即可。包含后,如果用应用管理程序切换应用时将不会看到当前应用的屏幕快照 | 所在位置:cordova-plugin-privacyscreen
调用名称:PrivacyScreenPlugin |
appUtils | 提供app更新 资源包更新能力设置首页等相关能力 | 所在位置:com.justep.cordova.plugin.app.utils
调用名称:navigator.appUtils |
百度定位插件 | 百度定位插件,提供定位相关能力,仅限安卓客户端 | 所在位置:com.justep.cordova.plugin.baidulocation
调用名称:navigator.baiduLocation 案例路径/UI2/takeout |
百度地图插件旧版 | 调用百度地图客户端 | 所在位置:com.justep.cordova.plugin.bmap
调用名称:导入相应模块 案例路径/UI2/system/api/native |
科大讯飞插件 (使用方法) | 集成了科大讯飞的SDK,提供语音听写、语音合成的功能 | 所在位置:com.justep.cordova.plugin.iFlytek
调用名称:navigator.speech 参数:需要 |
QQ插件 | 集成了QQSDK,提供了授权登录,分享功能 | 所在位置:com.justep.cordova.plugin.QQ
调用名称:navigator.QQ 参数:需要 案例路径:/UI2/demo/native/share |
安全验证插件 | 集成了mobSDK,提供短信验证的功能 | 所在位置:com.justep.cordova.plugin.security.mob
调用名称:navigator.mobsms 参数:需要 案例路径:/UI2/demo/netease |
指纹识别 (使用方法) | 苹果设备指纹识别插件 | 所在位置:com.justep.cordova.plugin.touchid
调用名称:navigator.touchid |
音频控制插件 (使用方法) | 通过参数调节手机播放音频 | 所在位置:com.justep.cordova.plugin.voiceManager
调用名称:navigator.voiceManager |
微博插件 | 集成了weibo.SDK,提供微博授权登录与微博分享的能力 | 所在位置:com.justep.cordova.plugin.weibo
调用名称:navigator.Weibo 参数:需要 案例路径:/UI2/demo/native/share |
AppEvent | 为第三方提供各种活动,使其可供使用 | 所在位置:cordova-plugin-app-event
调用名称:导入模块 |
AppPreferences (使用方法) | 应用属性设置插件 | 所在位置:cordova-plugin-app-preferences
调用名称:plugins.appPreferences |
增强型浏览器 | 基于Crosswalk引擎的浏览器,能力比自带webview更,但会增大apk体积,只针对于安卓 | 所在位置:cordova-plugin-crosswalk-webview |
md5插件 | 根据一个文件生成对应的md5值 | 所在位置:cordova-plugin-fastrde-md5
调用名称:window.downloader |
sim插件 | 获取手机sim卡信息 | 所在位置:cordova-plugin-sim
调用名称:window.plugins.sim 案例路径:/UI2/demo/plugin/sim |
AFNetworking
|
提供iOS上常用的AFNetworking框架,不需要主动调用 | 所在位置:com.justep.cordova.plugin.AFNetworking |
ace插件 | 微软公司提供的插件,可以使用html和js非常容易的创建原生UI并调用原生代码。 | 所在位置:cordova-plugin-ace
调用名称:ace |
百度地图插件基础模块(使用方法)
|
集成了百度地图SDK的基础模块,可在应用内嵌入百度地图 | 所在位置:com.justep.cordova.plugin.baiduMapBase
调用名称:navigator.baiduMap.base 案例路径:/UI2/demo/plugin/baiduMap |
百度地图插件搜索模块(使用方法) | 集成了百度地图SDK的搜索模块,依赖于百度地图插件基础版 | 所在位置:com.justep.cordova.plugin.baiduMapSearch
调用名称:navigator.baiduMap.search 案例路径:/UI2/demo/plugin/baiduMap |
wifi插件 | 获取手机wifi相关信息,iOS与Android略有差异 | 所在位置:cordova-plugin-wifi
调用名称:plugins.WifiAdmin |
图片选择插件 | 在图片库选择一张或者多张图片 | 所在位置:com.synconset.imagepicker
调用名称:plugins.imagePicker 案例路径:UI2/demo/plugin/imagepicker |
系统设置插件 | 打开系统设置的插件 | 所在位置:cordova-open-native-settings
调用名称:cordova.plugins.settings |
本文由WeX5君整理,WeX5一款开源免费的html5开发工具,H5 App开发就用WeX5!
阅读其他app 开发相关文章:http://doc.wex5.com/?p=3443
各种牛b
我们公司只用到了一部分,看到这个,我真想拜师了