属性:
方法:
对象:
回调方法:
权限:
5+功能模块(permissions)
isRecovery
当前Webview窗口是否由于内核崩溃自动恢复
说明:
Boolean 类型 只读属性
如果当前窗口是由于内核(WKWebview)崩溃恢复则返回true,否则返回false。 注意:仅iOS平台使用WKWebview内核时生效。
平台支持:
- Android - ALL (不支持)
- iOS - 8.0+ (支持)
all
获取所有Webview窗口
说明:
获取应用中已创建的所有Webview窗口,包括所有未显示的Webview窗口。 返回WebviewObject对象在数组中按创建的先后顺序排列,即数组中第一个WebviewObject对象用是加载应用的入口页面。
参数:
无
返回值:
Array[WebviewObject] : 应用中创建的所有Webview窗口对象数组。
示例:
uni-app使用plus注意事项
close
关闭Webview窗口
说明:
关闭已经打开的Webview窗口,需先获取窗口对象或窗口id,并可指定关闭窗口的动画及动画持续时间。
参数:
- id_wvobj: ( String | WebviewObject ) 必选 要关闭Webview窗口id或窗口对象
若操作窗口对象已经关闭,则无任何效果。 使用窗口id时,则查找对应id的窗口,如果有多个相同id的窗口则操作最先打开的窗口,若没有查找到对应id的WebviewObject对象,则无任何效果。
- aniClose: ( AnimationTypeClose ) 可选 关闭Webview窗口的动画效果
如果没有指定关闭窗口动画,则使用默认值“auto”,即使用显示时设置的窗口动画相对应的关闭动画。
- duration: ( Number ) 可选 关闭Webview窗口动画的持续时间
单位为ms,如果没有设置则使用显示窗口动画时间。
- extras: ( WebviewExtraOptions ) 可选 关闭Webview窗口扩展参数
可用于指定Webview窗口动画是否使用图片加速。
返回值:
void : 无
示例:
uni-app使用plus注意事项
create
创建新的Webview窗口
说明:
创建Webview窗口,用于加载新的HTML页面,可通过styles设置Webview窗口的样式,创建完成后需要调用show方法才能将Webview窗口显示出来。
参数:
- url: ( String ) 可选 新窗口加载的HTML页面地址
新打开Webview窗口要加载的HTML页面地址,可支持本地地址和网络地址。
- id: ( String ) 可选 新窗口的标识
窗口标识可用于在其它页面中通过getWebviewById来查找指定的窗口,为了保持窗口标识的唯一性,应该避免使用相同的标识来创建多个Webview窗口。 如果传入无效的字符串则使用url参数作为WebviewObject窗口的id值。
- styles: ( WebviewStyles ) 可选 创建Webview窗口的样式(如窗口宽、高、位置等信息)
- extras: ( Object ) 可选 创建Webview窗口的额外扩展参数
值为JSON类型,设置扩展参数后可以直接通过Webview的点(“.”)操作符获取扩展参数属性值,如: var w=plus.webview.create('url.html','id',{},{preload:'preload webview'}); // 可直接通过以下方法获取preload值 console.log(w.preload); // 输出值为“preload webview”
返回值:
WebviewObject : Webview窗口对象
示例:
uni-app使用plus注意事项
currentWebview
获取当前窗口的WebviewObject对象
说明:
获取当前页面所属的Webview窗口对象。
参数:
无
返回值:
WebviewObject : Webview窗口对象
示例:
uni-app使用plus注意事项
getDisplayWebview
获取屏幕所有可视的Webview窗口
说明:
仅在屏幕区域显示的Webview窗口,如果Webview窗口显示了但被其它Webview窗口盖住则认为不可视。
参数:
无
返回值:
Array[WebviewObject] : 屏幕中可视的Webview窗口对象数组。
示例:
uni-app使用plus注意事项
getWebviewById
查找指定标识的WebviewObject窗口
说明:
在已创建的窗口列表中查找指定标识的Webview窗口并返回。 若没有查找到指定标识的窗口则返回null,若存在多个相同标识的Webview窗口,则返回第一个创建的Webview窗口。 如果要获取应用入口页面所属的Webview窗口,其标识为应用的%APPID%,可通过plus.runtime.appid获取。
参数:
- id: ( String ) 必选 要查找的Webview窗口标识
返回值:
WebviewObject : WebviewObject窗口对象
示例:
uni-app使用plus注意事项
getLaunchWebview
获取应用首页WebviewObject窗口对象
参数:
无
返回值:
WebviewObject : WebviewObject窗口对象
示例:
uni-app使用plus注意事项
getSecondWebview
获取应用第二个首页WebviewObject窗口对象
说明:
在双首页模式下(在manifest.json的plus->secondwebview节点下配置),应用会自动创建两个首页Webview,通过getLaunchWebview()可获取第一个首页窗口对象,通过getSecondWebview()可获取第二个首页窗口对象。
参数:
无
返回值:
WebviewObject : WebviewObject窗口对象,在非双首页模式下则返回undefined。
示例:
uni-app使用plus注意事项
getTopWebview
获取应用显示栈顶的WebviewObject窗口对象
参数:
无
返回值:
WebviewObject : WebviewObject窗口对象
示例:
uni-app使用plus注意事项
hide
隐藏Webview窗口
说明:
根据指定的WebviewObject对象或id隐藏Webview窗口,使得窗口不可见。
参数:
- id_wvobj: ( String | WebviewObject ) 必选 要隐藏的Webview窗口id或窗口对象
使用窗口对象时,若窗口对象已经隐藏,则无任何效果。 使用窗口id时,则查找对应id的窗口,如果有多个相同id的窗口则操作最先打开的,若没有查找到对应id的WebviewObject对象,则无任何效果。
- aniHide: ( AnimationTypeClose ) 可选 隐藏Webview窗口的动画效果
如果没有指定窗口动画,则使用默认动画效果“none”。
- duration: ( Number ) 可选 隐藏Webview窗口动画的持续时间
单位为ms,如果没有设置则使用默认窗口动画时间。
- extras: ( WebviewExtraOptions ) 可选 隐藏Webview窗口扩展参数
可用于指定Webview窗口动画是否使用图片加速。
返回值:
void : 无
示例:
uni-app使用plus注意事项
open
创建并打开Webview窗口
说明:
创建并显示Webview窗口,用于加载新的HTML页面,可通过styles设置Webview窗口的样式,创建完成后自动将Webview窗口显示出来。
参数:
- url: ( String ) 可选 打开窗口加载的HTML页面地址
新打开Webview窗口要加载的HTML页面地址,可支持本地地址和网络地址。
- id: ( String ) 可选 打开窗口的标识
窗口标识可用于在其它页面中通过getWebviewById来查找指定的窗口,为了保持窗口标识的唯一性,应该避免使用相同的标识来创建多个Webview窗口。 如果传入无效的字符串则使用url参数作为WebviewObject窗口的id值。
- styles: ( WebviewStyles ) 可选 创建Webview窗口的样式(如窗口宽、高、位置等信息)
- aniShow: ( AnimationTypeShow ) 可选 显示Webview窗口的动画效果
如果没有指定窗口动画,则使用默认无动画效果“none”。
- duration: ( Number ) 可选 显示Webview窗口动画的持续时间
单位为ms,默认值为200ms(毫秒)。
- showedCB: ( SuccessCallback ) 可选 Webview窗口显示完成的回调函数
当指定Webview窗口显示动画执行完毕时触发回调函数,窗口无动画效果(如"none"动画效果)时也会触发此回调。
返回值:
WebviewObject : WebviewObject窗口对象
示例:
uni-app使用plus注意事项
prefetchURL
预载网络页面
说明:
预载网络页面会向服务器发起http/https请求获取html页面内容, 待Webview窗口加载此url页面时会则根据缓存机制优先使用预载的页面内容(加快页面显示速度)。 注意:预载网络页面仅在运行期生效,为了节省内存仅保留最后5个预载页面数据。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
prefetchURLs
预载网络页面(多个地址)
说明:
预载网络页面会向服务器发起http/https请求获取html页面内容, 待Webview窗口加载此url页面时会则根据缓存机制优先使用预载的页面内容(加快页面显示速度)。 注意:预载网络页面仅在运行期生效,为了节省内存仅保留最后5个预载页面数据。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
show
显示Webview窗口
说明:
显示已创建或隐藏的Webview窗口,需先获取窗口对象或窗口id,并可指定显示窗口的动画及动画持续时间。
参数:
- id_wvobj: ( String | WebviewObject ) 必选 要显示Webview窗口id或窗口对象
若操作Webview窗口对象显示,则无任何效果。 使用窗口id时,则查找对应id的窗口,如果有多个相同id的窗口则操作最先创建的窗口,若没有查找到对应id的WebviewObject对象,则无任何效果。
- aniShow: ( AnimationTypeShow ) 可选 显示Webview窗口的动画效果
如果没有指定窗口动画类型,则使用默认值“auto”,即自动选择上一次显示窗口的动画效果,如果之前没有显示过,则使用“none”动画效果。
- duration: ( Number ) 可选 显示Webview窗口动画的持续时间
单位为ms,如果没有设置则使用默认窗口动画时间600ms。
- showedCB: ( SuccessCallback ) 可选 Webview窗口显示完成的回调函数
当指定Webview窗口显示动画执行完毕时触发回调函数,窗口无动画效果(如"none"动画效果)时也会触发此回调。
- extras: ( WebviewExtraOptions ) 可选 显示Webview窗口扩展参数
可用于指定Webview窗口动画是否使用图片加速。
返回值:
WebviewObject : Webview窗口对象
示例:
uni-app使用plus注意事项
startAnimation
Webview窗口组合动画
说明:
同步组合两个Webview窗口动画,动画完成后窗口的位置会发生变化,一次需要在动画属性参数中设置动画起始位置、结束位置等。 注意:此动画操作会改变窗口位置(如left值等),再次调用show方法时需要确保其位置是否在可视区域,如果不在可视区域则需要调用窗口的setStyle方法设置其位置到可视区域内,如setStyle({left:'0px'});。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
defaultHardwareAccelerated
获取Webview默认是否开启硬件加速
说明:
由于不同设备对硬件加速的支持情况存在差异,开启硬件加速能加速HTML页面的渲染,但也会消耗更多的系统资源,从而导致在部分设备上可能出现闪屏、发虚、分块渲染等问题, 因此5+ Runtime会根据设备实际支持情况自动选择是否开启硬件加速。 关闭硬件加速则可能会导致Webview页面无法支持Video标签播放视频等问题,如果在特定情况下需要调整修改默认开启硬件加速的行为,则可通过plus.webview.defaultHardwareAccelerated()方法获取当前设备默认是否开启硬件加速状态,从而决定是否需要显式开启或关闭指定Webview的硬件加速功能(通过WebviewStyles的hardwareAccelerated属性设置)。
参数:
无
返回值:
Boolean : Webview窗口默认开启硬件加速则返回true,否则返回false。
平台支持:
- Android - 2.3+ (支持) :
返回当前设备默认是否开启硬件加速。
- iOS - 5.1+ (不支持) :
返回固定值true。
示例:
uni-app使用plus注意事项
AnimationTypeShow
一组用于定义页面或控件显示动画效果
常量:
- "auto": (String 类型 )自动选择动画效果
自动选择动画效果,使用上次显示窗口设置的动画效果,如果是第一次显示则默认动画效果“none”。
- "none": (String 类型 )无动画效果
立即显示页面,无任何动画效果,页面显示默认的动画效果。 此效果忽略动画时间参数,立即显示。 对应关闭动画"none"。
- "slide-in-right": (String 类型 )从右侧横向滑动效果
页面从屏幕右侧外向内横向滑动显示。 对应关闭动画"slide-out-right"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-in-left": (String 类型 )从左侧横向滑动效果
页面从屏幕左侧向右横向滑动显示。 对应关闭动画"slide-out-left"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-in-top": (String 类型 )从上侧竖向滑动效果
页面从屏幕上侧向下竖向滑动显示。 对应关闭动画"slide-out-top"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-in-bottom": (String 类型 )从下侧竖向滑动效果
页面从屏幕下侧向上竖向滑动显示。 对应关闭动画"slide-out-bottom"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "fade-in": (String 类型 )从透明到不透明逐渐显示效果
页面从完全透明到不透明逐渐显示。 对应关闭动画"fade-out"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "zoom-out": (String 类型 )从小到大逐渐放大显示效果
页面在屏幕中间从小到大逐渐放大显示。 对应关闭动画"zoom-in"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为100ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为100ms。
- "zoom-fade-out": (String 类型 )从小到大逐渐放大并且从透明到不透明逐渐显示效果
页面在屏幕中间从小到大逐渐放大并且从透明到不透明逐渐显示。 对应关闭动画"zoom-fade-in"。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为100ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为100ms。
- "pop-in": (String 类型 )从右侧平移入栈动画效果
页面从屏幕右侧滑入显示,同时上一个页面带阴影效果从屏幕左侧滑出隐藏。 对应关闭动画"pop-out"。
平台支持
AnimationTypeClose
一组用于定义页面或控件关闭的动画效果
常量:
- "auto": (String 类型 )自动选择动画效果
自动选择显示窗口相对于的动画效果。
- "none": (String 类型 )无动画
立即关闭页面,无任何动画效果。 此效果忽略动画时间参数,立即关闭。
- "slide-out-right": (String 类型 )横向向右侧滑出屏幕动画
页面从屏幕中横向向右侧滑动到屏幕外关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-out-left": (String 类型 )横向向左侧滑出屏幕动画
页面从屏幕中横向向左侧滑动到屏幕外关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-out-top": (String 类型 )竖向向上侧滑出屏幕动画
页面从屏幕中竖向向上侧滑动到屏幕外关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "slide-out-bottom": (String 类型 )竖向向下侧滑出屏幕动画
页面从屏幕中竖向向下侧滑动到屏幕外关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "fade-out": (String 类型 )从不透明到透明逐渐隐藏动画
页面从不透明到透明逐渐隐藏关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为200ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为300ms。
- "zoom-in": (String 类型 )从大逐渐缩小关闭动画
页面逐渐向页面中心缩小关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为100ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为100ms。
- "zoom-fade-in": (String 类型 )从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画
页面逐渐向页面中心缩小并且从不透明到透明逐渐隐藏关闭。
平台支持
- Android - 2.2+ (支持) :
默认动画时间为100ms。
- iOS - 5.1.1+ (支持) :
默认动画时间为100ms。
- "pop-out": (String 类型 )从右侧平移出栈动画效果
页面从屏幕右侧滑出消失,同时上一个页面带阴影效果从屏幕左侧滑入显示。
平台支持
WebviewObject
Webview窗口对象,用于操作加载HTML页面的窗口
属性:
方法:
事件:
id
Webview窗口的标识
说明:
String 类型 只读属性
调用plus.webview.create或plus.webview.open新建窗口时传入的id参数值,如果没有设置id参数,此属性值为undefined。 注意:窗口标识只能在创建时设置,不支持动态修改,不要对此属性进行赋值操作。
示例:
uni-app使用plus注意事项
addEventListener
添加事件监听器
说明:
向Webview窗口添加事件监听器,当指定的事件发生时,将触发listener函数的执行。 可多次调用此方法向Webview添加多个监听器,当监听的事件发生时,将按照添加的先后顺序执行。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
append
在Webview窗口中添加子窗口
说明:
将另一个Webview窗口作为子窗口添加到当前Webview窗口中,添加后其所有权归父Webview窗口,当父窗口关闭时子窗口自动关闭。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
appendJsFile
添加Webview窗口预加载js文件
说明:
对于一些网络HTML页面,在无法修改HTML页面时可通过此方法自动加载本地js文件。 当Webview窗口跳转到新页面时也会自动加载指定的js执行,添加多个js文件将按照添加的先后顺序执行。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
animate
Webview窗口内容动画
说明:
动画后可能会导致Webview窗口显示内容改变,可通过调用restore方法恢复。 当Webview窗口内容动画引起内容不可见(透明),将显示此窗口后面的内容。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
back
后退到上次加载的页面
说明:
Webview窗口历史记录操作,后退到窗口上次加载的HTML页面。 如果窗口历史记录中没有可后退的页面则不触发任何操作。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
beginPullToRefresh
开始Webview窗口的下拉刷新
说明:
开始触发下拉刷新效果,与用户操作下拉刷新行为一致(有动画效果)。 触发setPullTorefresh方法设置的下拉刷新事件回调。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
canBack
查询Webview窗口是否可后退
说明:
Webview窗口历史记录查询操作,获取Webview是否可后退到历史加载的页面,结果通过queryCallback回调方法返回。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
canForward
查询Webview窗口是否可前进
说明:
Webview窗口历史记录查询操作,获取Webview是否可前进到历史加载的页面,结果通过queryCallback回调方法返回。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
checkRenderedContent
检测Webview窗口是否渲染完成
说明:
检测方式为判断的Webview窗口内容是否为白屏,如果非白屏则认为渲染完成,否则认为渲染未完成。 通过successCallback回调函数返回结果,如果检测过程中发生错误则触发errorCallback回调函数。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - ALL (不支持)
示例:
uni-app使用plus注意事项
children
获取Webview窗口的所有子Webview窗口
说明:
获取添加到Webview窗口中的所有子Webview窗口,如果没有子Webview窗口则返回空数组。
参数:
无
返回值:
Array[WebviewObject] : 包含的子Webview窗口对象数组,没有则返回空数组。
示例:
uni-app使用plus注意事项
clear
清空原生Webview窗口加载的内容
说明:
清除原生窗口的内容,用于重置原生窗口加载的内容,清除其加载的历史记录等内容。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
close
关闭Webview窗口
说明:
关闭并销毁Webview窗口,可设置关闭动画和动画持续时间。
参数:
- aniClose: ( AnimationTypeClose ) 可选 关闭Webview窗口动画效果
如果没有指定关闭窗口动画,则使用默认值“auto”,即使用显示时设置的窗口动画相对应的关闭动画。
- duration: ( Number ) 可选 关闭Webview窗口的动画持续时间
单位为ms,默认为窗口show方法设定的动画时间。
- extras: ( WebviewExtraOptions ) 可选 关闭Webview窗口扩展参数
可用于指定Webview窗口动画是否使用图片加速。
返回值:
void : 无
示例:
uni-app使用plus注意事项
drag
设置Webview窗口的滑屏操作手势
说明:
将Webview窗口的左右滑动手势关联到其它Webview窗口,可实现滑动切换显示Webview的动画效果(如Tab页面切换效果)。 注意:滑屏操作会改变窗口位置(如left值等),如果不在可视区域则需要调用窗口的setStyle方法设置其位置到可视区域内,如setStyle({left:'0px'});。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
draw
截屏绘制
说明:
将Webview窗口的可视区域截屏并绘制到Bitmap图片对象中。
参数:
返回值:
void : 无
平台支持:
示例:
uni-app使用plus注意事项
endPullToRefresh
结束Webview窗口的下拉刷新
说明:
关闭下拉刷新效果,恢复到开始下拉刷新之前的效果。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
evalJS
在Webview窗口中执行JS脚本
说明:
将JS脚本发送到Webview窗口中运行,可用于实现Webview窗口间的数据通讯。
参数:
- js: ( String ) 必选 要在窗口中运行的脚本字符串
返回值:
void : 无
示例:
uni-app使用plus注意事项
forward
前进到上次加载的页面
说明:
Webview窗口历史记录操作,前进到窗口上次加载的HTML页面。 如果窗口历史记录中没有可前进的页面则不触发任何操作。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
getFavoriteOptions
获取Webview窗口的收藏参数
说明:
获取Webview窗口的收藏参数,如收藏页面的标题、图标、地址等。
参数:
无
返回值:
WebviewFavoriteOptions : 获取Webview窗口的收藏参数,如果未设置则返回null。
示例:
uni-app使用plus注意事项
getSafeAreaInsets
获取页面的安全区域
说明:
Webview窗口内容区域的安全区域位置信息。 如页面底部与底部安全区域重叠10px, 则返回的bottom值为10,否则返回0。
参数:
无
返回值:
plus.navigator.SafeAreaInsets : 页面的安全区域信息
getShareOptions
获取Webview窗口的分享参数
说明:
获取Webview窗口的分享参数,如分享的标题、图标、链接地址等。
参数:
无
返回值:
WebviewShareOptions : 获取Webview窗口的分享参数
示例:
uni-app使用plus注意事项
getStyle
获取Webview窗口的样式
说明:
获取Webview窗口的样式属性,如窗口位置、大小等信息。
参数:
无
返回值:
WebviewStyles : WebviewStyles对象
示例:
uni-app使用plus注意事项
getSubNViews
获取Webview窗口的原生子View控件对象
说明:
创建Webview窗口的所有原生子View控件。 可以在创建窗口时设置其subNViews属性自动创建(应用首页可通过manfest.json中的plus->launchwebview->subNNViews节点配置创建); 也可以通过Webview窗口的append方法将已经创建的原生View控件添加为其子。
参数:
无
返回值:
Array[plus.nativeObj.View] : 原生View控件对象数组,如果没有原生子View控件则返回空数组
示例:
uni-app使用plus注意事项