web-view

web-view 是一个 web 浏览器组件,可以用来承载网页的容器,会自动铺满整个页面。

各小程序平台,web-view 加载的 url 需要在后台配置域名白名单,包括内部再次 iframe 内嵌的其他 url 。

属性说明

属性名类型说明平台差异说明
srcStringwebview 指向网页的链接
webview-stylesObjectwebview 的样式5+App
@messageEventHandler网页向应用 postMessage 时,会在特定时机(后退、组件销毁、分享)触发并收到消息。H5 暂不支持

src

来源5+AppH5微信小程序支付宝小程序百度小程序头条小程序
网络
本地暂不支持xxxx

webview-styles

属性类型说明
progressObject/Boolean进度条样式。仅加载网络 HTML 时生效,设置为 false 时禁用进度条。

progress

属性类型默认值说明
colorString#00FF00进度条颜色
  1. <template>
  2. <view>
  3. <web-view :webview-styles="webviewStyles"src="https://uniapp.dcloud.io/static/web-view.html"></web-view>
  4. </view>
  5. </template>
  6. <script>
  7. exportdefault{
  8. data(){
  9. return{
  10. webviewStyles:{
  11. progress:{
  12. color:'#FF3333'
  13. }
  14. }
  15. }
  16. }
  17. }
  18. </script>
  19. <style>
  20. </style>

注意:

  • 小程序仅支持加载网络网页,不支持本地html
  • 小程序端 web-view 组件一定有原生导航栏,下面一定是全屏的 web-view 组件,navigationStyle: custom 对 web-view 组件无效。
  • App 端使用 自定义组件模式 时,uni.web-view.js 的最低版为 uni.webview.1.5.1.js
  • App 平台同时支持网络网页和本地网页,但本地网页及相关资源(js、css等文件)必须放在 uni-app 项目根目录->hybrid->html 文件夹下,如下为一个加载本地网页的uni-app项目文件目录示例:
  1. ┌─components
  2. ├─hybrid
  3. └─html
  4. ├─css
  5. └─test.css
  6. ├─img
  7. └─icon.png
  8. ├─js
  9. └─test.js
  10. └─local.html
  11. ├─pages
  12. └─index
  13. └─index.vue
  14. ├─static
  15. ├─main.js
  16. ├─App.vue
  17. ├─manifest.json
  18. └─pages.json

示例

  1. <template>
  2. <view>
  3. <web-viewsrc="/hybrid/html/local.html"></web-view>
  4. </view>
  5. </template>

<web-view> 加载的网页中支持调用部分 uni 接口:

方法名说明平台差异说明
uni.navigateTonavigateTo
uni.redirectToredirectTo
uni.reLaunchreLaunch
uni.switchTabswitchTab
uni.navigateBacknavigateBack
uni.postMessage向应用发送消息头条小程序不支持
uni.getEnv获取当前环境头条小程序不支持

uni.postMessage(OBJECT)

网页向应用发送消息,在 <web-view>message 事件回调 event.detail.data 中接收消息。

Tips

  • 传递的消息信息,必须写在 data 对象中。
  • event.detail.data 中的数据,以数组的形式接收每次 post 的消息。

uni.getEnv(CALLBACK)

callback 返回的对象

属性类型说明
plusBoolean5+App
miniprogramBoolean微信小程序
smartprogramBoolean百度小程序
miniprogramBoolean支付宝小程序

示例

<web-view> 加载的 HTML 中,添加以下代码:

  1. <!-- 微信 JS-SDK 如果不需要兼容微信小程序,则无需引用此 JS 文件。 -->
  2. <scripttype="text/javascript"src="https://res.wx.qq.com/open/js/jweixin-1.4.0.js"></script>
  3. <!-- 支付宝的 JS-SDK 防止 404 需要动态加载,如果不需要兼容支付宝小程序,则无需引用此 JS 文件。 -->
  4. <scripttype="text/javascript">
  5. if(navigator.userAgent.indexOf('AlipayClient')>-1){
  6. document.writeln('<script src="https://appx/web-view.min.js"'+'>'+'<'+'/'+'script>');
  7. }
  8. </script>
  9. <!-- 百度 JS-SDK 如果不需要兼容百度小程序,则无需引用此 JS 文件。 -->
  10. <scripttype="text/javascript"src="https://b.bdstatic.com/searchbox/icms/searchbox/js/swan-1.7.0.js"></script>
  11. <!-- uni 的 SDK -->
  12. <scripttype="text/javascript"src="https://js.cdn.aliyun.dcloud.net.cn/dev/uni-app/uni.webview.1.5.1.js"></script>

待触发 UniAppJSBridgeReady 事件后,即可调用 uni 的 API。

<script>
    document.addEventListener('UniAppJSBridgeReady', function() {
        uni.postMessage({
            data: {
                action: 'message'
            }
        });
        uni.getEnv(function(res) {
            console.log('当前环境:' + JSON.stringify(res));
        });
    });
</script>

App端web-view的扩展

App端的webview是非常强大的,可以更灵活的控制和拥有更丰富的API。

每个vue页面,其实都是一个webview,而vue页面里的web-view组件,其实是webview里的一个子webview。这个子webview被append到父webview上。

通过以下方法,可以获得这个web-view组件对应的js对象,然后参考https://www.html5plus.org/doc/zh_cn/webview.html#plus.webview.WebviewObject,可以进一步重设这个web-view组件的样式,比如调整大小

<template>
    <view>
        <web-view src="https://www.baidu.com"></web-view>
    </view>
</template>
<script>
var wv;//计划创建的webview
export default {
    onReady() {
        // #ifdef APP-PLUS
        var currentWebview = this.$mp.page.$getAppWebview() //获取当前页面的webview对象
        setTimeout(function() {
            wv = currentWebview.children()[0]
            wv.setStyle({top:150,height:300})
        }, 1000); //如果是页面初始化调用时,需要延时一下
        // #endif
        }
    };
</script>

甚至可以不用web-view组件,直接js创建一个子webview来加载html。比如不希望远程网页使用plus的API,不管是因为安全原因还是因为back监听冲突,可以使用如下代码:

<template>
    <view>
    </view>
</template>
<script>
var wv;//计划创建的webview
export default {
    onLoad() {
        // #ifdef APP-PLUS
        wv = plus.webview.create("","custom-webview",{
            plusrequire:"none", //禁止远程网页使用plus的API,有些使用mui制作的网页可能会监听plus.key,造成关闭页面混乱,可以通过这种方式禁止
            top:uni.getSystemInfoSync().statusBarHeight+44 //放置在titleNView下方。如果还想在webview上方加个地址栏的什么的,可以继续降低TOP值
        })
        wv.loadURL("https://www.baidu.com")
        var currentWebview = this.$mp.page.$getAppWebview() //获取当前页面的webview对象
        currentWebview.append(wv);//一定要append到当前的页面里!!!才能跟随当前页面一起做动画,一起关闭
        setTimeout(function() {
            console.log(wv.getStyle())
        }, 1000);//如果是首页的onload调用时需要延时一下,二级页面无需延时,可直接获取
        // #endif
    }
};
</script>

web-view组件的层级问题解决

web-view组件在App和小程序中层级较高,如需要在vue页面中写代码为web-view组件覆盖内容,小程序端无解,只能由web-view的组件自己弹出div。App端有如下若干方案:

  • 比较简单的方式是actionsheet等原生弹出菜单
  • 也可以使用plus.nativeObj.view。这里有一个底部图标菜单的示例,可参考https://ext.dcloud.net.cn/plugin?id=69
  • 也可以使用HBuilderX1.9.10以后新出的原生子窗体subNvue
  • 也可以在web-view组件内嵌的网页中弹出z-index更高的div。如果是外部网页,可以在vue中获得子webview对象后,通过evalJS为这个子webview注入一段js,操作其弹出div层。注意事项

  • <web-view> 组件默认铺满全屏并且层级高于前端组件。App端想调节大小或再其上覆盖内容需使用plus规范。

  • <web-view> 组件所在窗口的标题,跟随页面的 <title> 值的变化而变化。
  • App端,web-view加载的html页面可以运行plus的api,但注意如果该页面调用了plus.key的API监听了back按键(或使用mui的封装),会造成back监听冲突。需要该html页面移除对back的监听。或按照上面的示例代码禁止网页使用plus对象
  • uni.webview.js 最新版地址:https://js.cdn.aliyun.dcloud.net.cn/dev/uni-app/uni.webview.1.5.1.js
  • 小程序平台,个人类型与海外类型的小程序使用 web-view 组件,提交审核时注意微信等平台是否允许使用
  • 小程序平台, src 指向的链接需登录小程序管理后台配置域名白名单。5+AppH5 无此限制。

FAQ

Q:web-view 的页面怎么和应用内的页面交互?A:调用 uni 相关的 API,就可以实现页面切换及发送消息。参考:在 web-view 加载的 HTML 中调用 uni 的 API

Q:web-view 加载的 HTML 中,能够调用 5+ 的能力么?A:加载的 HTML 中是有 5+ 环境的,在 plusready 后调用即可。参考:一个简单实用的 plusready 方法


发现错误?想参与编辑?在 GitHub 上编辑此页面!