# 编译到web端

新增于4.0版本

uni-app x 编译到web平台时,并非是与uni-app js引擎版一致。而是基于uts的统一规范,和编译到安卓端的一致性较高。

与App版相比,web版有几个较大的差别:

  1. web版是一个spa的单页应用,而app是多页的。
  2. pages.json配置的导航栏和tabbar,在web端并非原生的,而是网页的一部分。虽然uvue页面仍然是在导航栏和tabbar之间的,但在web平台,开发者可以直接操作导航栏和tabbar的dom。
  3. web版默认有页面滚动;app没有。

本文档会介绍与web和Android的差异及注意事项。

# web运行失败注意事项

  • 在比较早的HBuilderX版本中创建的uni-app x项目,特征是项目根目录是app.vue而不是app.uvue。这样的项目运行web会失败。需替换index.html和app.uvue这2个文件,可以新建项目从中复制,也可以从hello uni-app x示例项目复制。

# vue

# 特性支持情况

uni-app x编译到web端时遵循vue规范,目前有部分vue特性暂不支持。

不支持的特性如下

  • 指令:v-oncev-memo
  • render函数
  • 不支持组件中监听页面 onPageScrollonReachBottom 生命周期

部分支持的特性

  • mixin:需要使用defineMixin函数定义mixin,不可直接使用对象字面量定义mixin

自4.11版本起支持如下特性

  • 组合式API:defineOptionsdefineModeltoValuetoReftoRefshasInjectionContext

# refs

使用refs获取内置组件实例时会获取到对应的Element,而不是vue组件实例。

<template>
  <view ref="view"></view>
</template>
<script>
export default {
  onReady() {
    console.log(this.$refs['view']) // 此时获取到的是UniViewElement
  }
}
</script>

# vue实例相关属性类型问题

为保证运行性能,app安卓端部分属性(如:$data、$refs)被转为了Map类型(安卓端map支持使用下标访问),而web端仍是普通对象或proxy。为保证多端代码一致,在使用这些属性时可以统一为下标访问。

<template>
  <view></view>
</template>
<script>
export default {
  data() {
    return {
      a: 1
    }
  },
  onReady() {
    console.log(this.$data['a']) // 1
  }
}
</script>

# ComponentPublicInstance类型

目前已知组件使用emits会导致this不能直接传递给ComponentPublicInstance类型,需要as一下。

function log(ins: ComponentPublicInstance) {
  console.log(ins);
}

export default {
  emits: ['change', 'input'],
  methods: {
    buttonClick() {
      log(this as ComponentPublicInstance)
    }
  }
}

如下为进阶说明,可以不看

我们在代码中用到的ComponentPublicInstance为省略泛型的写法,最终推导出的ComponentPublicInstance类型为:

// 此处为方便说明,省略了很多属性、简化了写法
type ComponentPublicInstance = {
  $emit: (event: string, ...args: any[]) => void
}

对于使用了emits的组件,最终推导出来的this对应的类型为:

// 此处为方便说明,省略了很多属性、简化了写法
type XxxComponentPublicInstance = {
  $emit: (event: 'change' | 'input', ...args: any[]) => void
}

在将XxxComponentPublicInstance类型的this值赋值给ComponentPublicInstance类型的参数时,由于$emit类型无法兼容导致编译报错。

下面我们只看$emit的类型

type ComponentPublicInstanceEmit = (event: string, ...args: any[]) => void
type XxxComponentPublicInstanceEmit = (event: 'change' | 'input', ...args: any[]) => void

对于ComponentPublicInstanceEmit类型的函数A来说,event参数可以接收任意字符串,如果将其赋值为只能接收'change' | 'input'作为event参数的函数B,这时候用户如果将event参数设为'click'则函数B无法处理,而函数A的类型定义又可以接收'click',所以ts并不允许这种行为。

但是反过来则是可以的XxxComponentPublicInstanceEmit类型的函数A可以被重新赋值为ComponentPublicInstanceEmit类型的函数。

总结一下就是ts在比较函数参数是否兼容时使用逆变(contravariance)而非协变(covariance),这两个名词定义比较复杂,结合上述示例理解即可。

# 注意事项

  • data内$开头的属性不可直接使用this.$xxx访问,需要使用this.$data['$xxx'],这是vue的规范。目前安卓端可以使用this.$xxx访问是Bug而非特性,请勿使用此特性。
  • 安卓端由于kotlin特性组件内部使用组件data内定义的属性时this可以省略,请勿在web端使用此特性。
  • web端由于是一个单页应用,使用$root会获取应用根组件,而不是页面根组件。而安卓端是多页应用,$root获取的是页面根组件。
  • web端使用$parent会获取父组件(含内置组件),安卓端只会获取父级非内置组件,web端后续会调整,请勿利用此特性。
  • web端切换页面后上一个页面的元素、组件会从dom树上移除,并触发组件及页面的deactivate生命周期,此时部分dom事件无法触发(如:transitionEnd)。可以视情况使用activatedeactivate生命周期重新触发dom相关操作。

# uts

参考:类型兼容性

# css

# 默认样式

为保证多端统一,uni-app-x编译到web端时,内置组件根元素带有一些默认样式,详情参考:uvue css使用。如果是使用document.createElement等方式自行创建的html元素不会有这些默认样式。

# 样式格式自动转化

通过element.style.xxx设置样式时,web端会自动将样式进行转化,具体取决于浏览器。

例如:

element.style.color = '##FF0000'
element.style.color === 'rgb(255, 0, 0)' // true

# fixed定位

position: fixed定位时,web端为相对于整个浏览器页面进行定位,app端为相对于页面(除导航栏、tabbar)定位。可以使用css变量使两端表现一致

.fixed {
  position: fixed;
  width: 100px;
  height: 100px;
  background-color: #FF0000;
  left: 10px;
  /* #ifdef WEB */
  top: calc(--window-top + 10px);
  /* #endif */
  /* #ifdef APP */
  top: 10px;  /* App端暂不支持calc */
  /* #endif */
}

# api

uni相关的异步api在web端不传回调时会返回promise(详情参考:API Promise 化)。但是由于目前缺少此用法的类型定义,使用返回的Promise无法通过编译。另外安卓端暂未实现此功能,建议不要使用此特性。

# 特性支持

  • 宽屏适配
  • 暗黑模式
  • 国际化
  • 地图
  • uni-push2.0
  • 服务端渲染 新增于HBuilderX 4.18
  • 接口Promise化

# 运行与发行

运行到web端时,uni-app-x编译器不会对语法进行转化来兼容低版本浏览器。发行时会对代码进行转化,以保证低版本浏览器能正常运行。

发行时支持的最低浏览器版本为:chrome 64safari 11.1firefox 62edge 79safari on iOS 12

# 其他注意事项

  • 4.02之前的版本内置组件的tagName、nodeName与安卓端不同,web端和安卓端相比多了UNI-前缀,例如web端为UNI-VIEWUNI-IMAGE,安卓端为VIEWIMAGE。此问题已在HBuilderX 4.02版本修复,web端移除了UNI-前缀。