原文链接: https://interview.poetries.top/docs/excellent-docs/12-Uniapp%E6%A8%A1%E5%9D%97.html

入门uniapp

1 基础部分总结

什么是UniApp?它有哪些特点和优势?

uni-app 是一个使用 Vue.js (opens new window) 开发所有前端应用的框架,开发者编写一套代码,可发布到iOS、Android、Web(响应式)、以及各种小程序(微信/支付宝/百度/头条/飞书/QQ/快手/钉钉/淘宝)、快应用等多个平台

uni-app简单来说是 vue的语法 + 小程序的api,它遵循Vue.js语法规范,组件和API遵循微信小程序命名,这些都属于通用技术栈,学习它们是前端必备技能,uni- app没有太多额外学习成本

uni-app 支持的手机版本最低到多少

  • Web端:uni-app没有限制,同vue2和vue3自身能支持的浏览器版本
  • 小程序端:uni-app没有限制,同该小程序自身能支持的最低平台
  • App端:
    • Vue2: Android4.4+、iOS9+。Android4.4已经是2013年发布的手机了。
    • Vue3: 支持的范围是:Android >=5 (使用nvue和vue有区别。某些老国产Android5的rom无法动态升级Android system webview,此时如果使用vue页面需搭配x5内核) , iOS >= 10

uniapp特点

  • 跨平台更多
    • 真正做到一套代码、多端发行
    • 条件编译:优雅的在一个项目里调用不同平台的特色功能
  • 运行体验更好
    • 组件、api与微信小程序一致
    • 兼容weex原生渲染
  • 通用技术栈,学习成本更低
    • vue的语法、微信小程序的api
    • 内嵌mpvue
  • 开发生态,拥抱社区
    • 支持通过npm安装第三方包
    • 支持微信小程序自定义组件及SDK
    • 兼容mpvue组件及项目
    • app端支持和原生混合编码
    • dcloud插件市场

uniapp平台功能示意图

Uniapp的目录结构组成

一个 uni-app 工程,就是一个 Vue 项目,你可以通过 HBuilderX 或 cli 方式快速创建 uni-app 工程

一个uni-app工程,默认包含如下目录及文件

    ┌─uniCloud              云空间目录,阿里云为uniCloud-aliyun,腾讯云为uniCloud-tcb(详见uniCloud)
    │─components            符合vue组件规范的uni-app组件目录
    │  └─comp-a.vue         可复用的a组件
    ├─utssdk                存放uts文件
    ├─pages                 业务页面文件存放的目录
    │  ├─index
    │  │  └─index.vue       index页面
    │  └─list
    │     └─list.vue        list页面
    ├─static                存放应用引用的本地静态资源(如图片、视频等)的目录,注意:静态资源只能存放于此
    ├─uni_modules           存放[uni_module](/uni_modules)
    ├─platforms             存放各平台专用页面的目录,详见
    ├─nativeplugins         App原生语言插件 详见
    ├─nativeResources       App端原生资源目录
    │  └─android            Android原生资源目录 详见
    ├─hybrid                App端存放本地html文件的目录,详见
    ├─wxcomponents          存放小程序组件的目录,详见
    ├─unpackage             非工程代码,一般存放运行或发行的编译结果
    ├─AndroidManifest.xml   Android原生应用清单文件 详见
    ├─main.js               Vue初始化入口文件
    ├─App.vue               应用配置,用来配置App全局样式以及监听 应用生命周期
    ├─manifest.json         配置应用名称、appid、logo、版本等打包信息,详见
    ├─pages.json            配置页面路由、导航条、选项卡等页面类信息,详见
    └─uni.scss              这里是uni-app内置的常用样式变量

static目录 使用注意

  • 编译到任意平台时,static 目录下除不满足条件编译的文件,会直接复制到最终的打包目录,不会打包编译。非 static 目录下的文件(vue、js、css 等)只有被引用时,才会被打包编译。
  • css、less/scss 等资源不要放在 static 目录下,建议这些公用的资源放在自建的 common 目录下

Vue.js和UniApp有什么关系?它们之间有什么区别?

Vue.js是一种用于构建用户界面的渐进式JavaScript框架,而UniApp是基于Vue.js的跨平台应用开发框架。UniApp在Vue.js的基础上进行了扩展,使得开发者可以使用Vue.js的开发方式和语法来编写跨平台应用。与Vue.js相比,UniApp具有以下区别:

  • 平台适配性 :Vue.js主要用于构建Web应用,而UniApp能够生成多个平台的应用,包括小程序、H5和App等。
  • 原生能力访问 :UniApp提供了对原生平台的API和能力的访问,使得开发者可以更方便地使用平台的特性和功能。
  • 组件库和UI样式 :UniApp提供了一套基于Vue.js的组件库和UI样式,方便开发者快速构建应用的界面和交互。

如何在UniApp中进行网络请求?

UniApp中可以使用uni.request方法进行网络请求。以下是一个基本的网络请求示例:

    uni.request({
      url: 'https://api.example.com/data',
      method: 'GET',
      data: {
        // 请求参数
      },
      success: function(res) {
        // 请求成功回调
        console.log(res.data);
      },
      fail: function(err) {
        // 请求失败回调
        console.log(err);
      }
    });

做个简单封装

    import store from '@/store'
    import config from '@/config'
    import { getToken } from '@/utils/auth'
    import errorCode from '@/utils/errorCode'
    import { toast, showConfirm, tansParams } from '@/utils/common'
    
    let timeout = 10000
    const baseUrl = config.baseUrl
    
    const request = config => {
      // 是否需要设置 token
      const isToken = (config.headers || {}).isToken === false
      config.header = config.header || {}
      if (getToken() && !isToken) {
        config.header['Authorization'] = 'Bearer ' + getToken()
      }
      // get请求映射params参数
      if (config.params) {
        let url = config.url + '?' + tansParams(config.params)
        url = url.slice(0, -1)
        config.url = url
      }
      return new Promise((resolve, reject) => {
        uni.request({
            method: config.method || 'get',
            timeout: config.timeout ||  timeout,
            url: config.baseUrl || baseUrl + config.url,
            data: config.data,
            header: config.header,
            dataType: 'json'
          }).then(response => {
            let [error, res] = response
            if (error) {
              toast('后端接口连接异常')
              reject('后端接口连接异常')
              return
            }
            const code = res.data.code || 200
            const msg = errorCode[code] || res.data.msg || errorCode['default']
            if (code === 401) {
              showConfirm('登录状态已过期,您可以继续留在该页面,或者重新登录?').then(res => {
                if (res.confirm) {
                  store.dispatch('LogOut').then(res => {
                    uni.reLaunch({ url: '/pages/login' })
                  })
                }
              })
              reject('无效的会话,或者会话已过期,请重新登录。')
            } else if (code === 500) {
              toast(msg)
              reject('500')
            } else if (code !== 200) {
              toast(msg)
              reject(code)
            }
            resolve(res.data)
          })
          .catch(error => {
            let { message } = error
            if (message === 'Network Error') {
              message = '后端接口连接异常'
            } else if (message.includes('timeout')) {
              message = '系统接口请求超时'
            } else if (message.includes('Request failed with status code')) {
              message = '系统接口' + message.substr(message.length - 3) + '异常'
            }
            toast(message)
            reject(error)
          })
      })
    }
    
    export default request

css 的引用

如果我们创建自定义的样式文件,例如创建一个/static/scss/test.css,想要使其在全局引用。

1、在App.vue中全局引用,每个页面都可以使用该样式。

    <style lang="scss">
      @import '@/static/scss/test.css';
    </style>

2、在index.scss中导入,每个页面都可以使用该样式。

    @import '@/static/scss/test.css';

推荐第二种方式,方便所有的样式文件在index.scss统一管理和维护。

css 的变量

css 变量描述
--status-bar-height系统状态栏高度
--window-top内容区域距离顶部的距离
--window-bottom内容区域距离底部的距离

注意:

  • var(--status-bar-height)此变量在微信小程序环境为固定25px,在App里为手机实际状态栏高度。
  • 当设置"navigationStyle":"custom"取消原生导航栏后,由于窗体为沉浸式,占据了状态栏位置。此时可以使用一个高度为var(--status-bar-height)的 view 放在页面顶部,避免页面内容出现在状态栏。
  • 由于在 H5 端,不存在原生导航栏和 tabbar,也是前端 div 模拟。如果设置了一个固定位置的居底 view,在小程序和 App 端是在 tabbar 上方,但在 H5 端会与 tabbar 重叠。此时可使用--window-bottom,不管在哪个端,都是固定在 tabbar 上方。
  • 目前 nvue 在 App 端,还不支持--status-bar-height变量,替代方案是在页面 onLoad 时通过uni.getSystemInfoSync().statusBarHeight获取状态栏高度,然后通过 style 绑定方式给占位 view 设定高度。下方提供了示例代码
    <template>
      <page-meta>
        <navigation-bar />
      </page-meta>
      <view>
        <view class="status_bar">
          <!-- 这里是状态栏 -->
        </view>
        <view>状态栏下的文字</view>
      </view>
    </template>
    <style>
      .status_bar {
        height: var(--status-bar-height);
        width: 100%;
      }
    </style>

nvue 页面获取状态栏高度

    <template>
      <view class="content">
        <view :style="{ height: iStatusBarHeight + 'px'}"></view>
      </view>
    </template>
    
    <script>
      export default {
        data() {
          return {
            iStatusBarHeight: 0,
          };
        },
        onLoad() {
          this.iStatusBarHeight = uni.getSystemInfoSync().statusBarHeight;
        },
      };
    </script>

全局变量机制

全局变量机制globalData,支持全端通用。

以下是 App.vue 中定义globalData的相关配置:

    <script>  
      export default {  
        globalData: {  
          text: 'text'  
        }
      }  
    </script>  

其他页面获取方式

    console.info(getApp().globalData.text);

修改globalData变量的方式如下:getApp().globalData.text = 'test'

注意

globalData是简单的全局变量,如果使用状态管理,请使用vuex(main.js中定义)

globalData是简单的全局变量,如果使用状态管理,请使用vuex(main.js中定义)

屏幕尺寸单位

    uni-app`支持的通用`css`单位包括`px``rpx
  • px即屏幕像素
  • rpx即响应式px,一种根据屏幕宽度自适应的动态单位。以750宽的屏幕为基准,750rpx恰好为屏幕宽度。屏幕变宽,rpx实际显示效果会等比放大 。

vue页面支持下面这些普通H5单位,但在nvue里不支持

  • rem根字体大小可以通过page-meta配置
  • vh viewpoint height,视窗高度,1vh等于视窗高度的1%
  • vw viewpoint width,视窗宽度,1vw等于视窗宽度的1%

生命周期

应用生命周期

uni-app支持如下应用生命周期函数

函数名说明
onLaunch当uni-app初始化完成时触发(全局只触发一次)
onShow当uni-app启动,或从后台进入前台显示
onHide当uni-app从前台进入后台
onError当uni-app报错时触发
onUniNViewMessage对nvue页面发送的数据进行监听
onUnhandledRejection对未处理的 Promise 拒绝事件监听函数
onPageNotFound页面不存在监听函数
onThemeChange监听系统主题变化

应用生命周期仅可在App.vue中监听,在其它页面监听无效

页面生命周期

uni-app支持如下页面生命周期函数

函数名说明
onInit监听页面初始化
onLoad监听页面加载
onShow监听页面显示
onReady监听页面初次渲染完成
onHide监听页面隐藏
onUnload监听页面卸载
onResize监听窗口尺寸变化
onPullDownRefresh监听用户下拉动作,一般用于下拉刷新
onReachBottom页面上拉触底事件的处理函数
onTabItemTap点击 tab 时触发
onShareAppMessage用户点击右上角分享
onPageScroll监听页面滚动
onNavigationBarButtonTap监听原生标题栏按钮点击事件
onBackPress监听页面返回
onNavigationBarSearchInputChanged监听原生标题栏搜索输入框输入内容变化事件
onNavigationBarSearchInputConfirmed监听原生标题栏搜索输入框搜索事件,用户点击软键盘上的“搜索”按钮时触发
onNavigationBarSearchInputClicked监听原生标题栏搜索输入框点击事件
onShareTimeline监听用户点击右上角转发到朋友圈
onAddToFavorites监听用户点击右上角收藏

onInit使用注意

  • 仅百度小程序基础库 3.260 以上支持 onInit 生命周期
  • 其他版本或平台可以同时使用 onLoad 生命周期进行兼容,注意避免重复执行相同逻辑
  • 不依赖页面传参的逻辑可以直接使用 created 生命周期替代

onReachBottom使用注意,可在pages.json里定义具体页面底部的触发距离onReachBottomDistance,比如设为50,那么滚动页面到距离底部50px时,就会触发onReachBottom事件。

如使用scroll-view导致页面没有滚动,则触底事件不会被触发。scroll-view滚动到底部的事件请参考scroll-view的文档

onPageScroll(监听滚动、滚动监听、滚动事件)参数说明:

属性类型说明
scrollTopNumber页面在垂直方向已滚动的距离(单位px)
  • onPageScroll里不要写交互复杂的js,比如频繁修改页面。因为这个生命周期是在渲染层触发的,在非h5端,js是在逻辑层执行的,两层之间通信是有损耗的。如果在滚动过程中,频发触发两层之间的数据交换,可能会造成卡顿。
    onPageScroll : function(e) { //nvue暂不支持滚动监听,可用bindingx代替
    	console.log("滚动距离为:" + e.scrollTop);
    },

onTabItemTap返回的json对象说明:

属性类型说明
indexString被点击tabItem的序号,从0开始
pagePathString被点击tabItem的页面路径
textString被点击tabItem的按钮文字
  • onTabItemTap常用于点击当前tabitem,滚动或刷新当前页面。如果是点击不同的tabitem,一定会触发页面切换。
  • 如果想在App端实现点击某个tabitem不跳转页面,不能使用onTabItemTap,可以使用plus.nativeObj放一个区块盖住原先的tabitem,并拦截点击事件。
  • 支付宝小程序平台onTabItemTap表现为点击非当前tabitem后触发,因此不能用于实现点击返回顶部这种操作
    onTabItemTap : function(e) {
      console.log(e);
      // e的返回格式为json对象: {"index":0,"text":"首页","pagePath":"pages/index/index"}
    },

onNavigationBarButtonTap参数说明:

属性类型说明
indexNumber原生标题栏按钮数组的下标
    onNavigationBarButtonTap : function (e) {
      console.log(e);
      // e的返回格式为json对象:{"text":"测试","index":0}
    }

onBackPress回调参数对象说明:

属性类型说明
fromString触发返回行为的来源:'backbutton'——左上角导航栏按钮及安卓返回键;'navigateBack'——uni.navigateBack() 方法。支付宝小程序端不支持返回此字段
    export default {
      data() {
        return {};
      },
      onBackPress(options) {
        console.log('from:' + options.from)
      }
    }

组件生命周期

uni-app组件支持的生命周期,与vue标准组件的生命周期相同。这里没有页面级的onLoad等生命周期:

函数名说明
beforeCreate在实例初始化之前被调用
created在实例创建完成后被立即调用
beforeMount在挂载开始之前被调用
mounted挂载到实例上去之后调用
beforeUpdate数据更新时调用
updated由于数据更改时调用
beforeDestroy实例销毁之前调用
destroyed实例销毁后调用

组件定义

注册

通过uni- appeasycom将组件引入精简为一步。只要组件安装在项目的components目录下,并符合components/组件名称/组件名称.vue目录结构。就可以不用引用、注册,直接在页面中使用。

    <template>
      <view>
    	<uni-badge text="1"></uni-badge>
      </view>
    </template>
    <script>
      // 这里不用import引入,也不需要在components内注册uni-badge组件。template里就可以直接用
      export default {
    	data() {
    	  return {}
    	}
      }
    </script>
  • easycom是自动开启的,不需要手动开启,有需求时可以在pages.jsoneasycom节点进行个性化设置
  • 不管components目录下安装了多少组件,easycom打包后会自动剔除没有使用的组件,对组件库的使用尤为友好。

props

props可以是数组或对象,用于接收来自父组件的数据。props可以是简单的数组,或者使用对象作为替代,对象允许配置高级选项,如类型检测、自定义验证和设置默认值。

选项类型说明
typeString、Number、Boolean、Array、Object、Date、Function、Symbol,任何自定义构造函数、或上述内容组成的数组会检查一个 prop 是否是给定的类型,否则抛出警告
defaultany为该 prop 指定一个默认值。如果该 prop 没有被传入,则换做用这个值。对象或数组的默认值必须从一个工厂函数返回
requiredBoolean定义该 prop 是否是必填项
validatorFunction自定义验证函数会将该 prop 的值作为唯一的参数代入。在非生产环境下,如果该函数返回一个 false 的值 (也就是验证失败),一个控制台警告将会被抛出

示例:子组件定义

    <template>
      <view>
    	<view>{{age}}</view>
      </view>
    </template>
    <script>
      export default {
    	props: {
    	  // 检测类型 + 其他验证
    	  age: {
    		type: Number,
    		default: 0,
    		required: true,
    		validator: function(value) {
    		  return value >= 0
    		}
    	  }
    	}
      }
    </script>

sync 修饰符

当一个子组件改变了一个prop的值时,这个变化也会同步到父组件中所绑定。.sync它会被扩展为一个自动更新父组件属性的v-on监听器。

    <!-- 父组件 -->
    <template>
      <view>
        <syncA :title.sync="title"></syncA>
      </view>
    </template>
    <script>
      export default {
        data() {
          return {
            title: "hello vue.js"
          }
        }
      }
    </script>
    <!-- 子组件 -->
    <template>
      <view>
        <view @click="changeTitle">{{title}}</view>
      </view>
    </template>
    <script>
      export default {
        props: {
          title: {
            default: "hello"
          },
        },
        methods: {
          changeTitle() {
            // 触发一个更新事件
            this.$emit('update:title', "test-app")
          }
        }
      }
    </script>

命名限制

uni-app中以下这些作为保留关键字,不可作为组件名。

a、canvas、cell、content、countdown、datepicker、div、element、embed、header、image、img、indicator、input、link、list、loading- indicator、loading、marquee、meta、refresh、richtext、script、scrollable、scroller、select、slider- neighbor、slider、slot、span、spinner、style、svg、switch、tabbar、tabheader、template、text、textarea、timepicker、transition- group、transition、video、view、web

条件编译

条件编译是用特殊的注释作为标记,在编译时根据这些特殊的注释,将注释里面的代码编译到不同平台。

写法以#ifdef#ifndef%PLATFORM%开头,以#endif结尾。

  • #ifdef:if defined 仅在某平台存在
  • #ifndef:if not defined 除了某平台均存在
  • %PLATFORM%:平台名称

仅出现在App平台下的代码

    #ifdef APP-PLUS
    需条件编译的代码
    #endif

除了H5平台,其它平台均存在的代码

    #ifndef H5
    需条件编译的代码
    #endif

H5平台微信小程序平台存在的代码

    #ifdef H5 || MP-WEIXIN
    需条件编译的代码
    #endif

注意

多个这里只有||,不可能出现&&,因为没有交集

平台名称参数

%PLATFORM%可取值如下:

生效条件
VUE3Vue3
APP-PLUSApp
APP-PLUS-NVUE或APP-NVUEApp nvue
H5H5
MP-WEIXIN微信小程序
MP-ALIPAY支付宝小程序
MP-BAIDU百度小程序
MP-TOUTIAO字节跳动小程序
MP-LARK飞书小程序
MP-QQQQ小程序
MP-KUAISHOU快手小程序
MP-JD京东小程序
MP-360360小程序
MP所有小程序
QUICKAPP-WEBVIEW所有快应用
QUICKAPP-WEBVIEW-UNION快应用联盟
QUICKAPP-WEBVIEW-HUAWEI快应用华为

注意

Vue3需要在项目的manifest.json文件根节点配置"vueVersion" : "3"

API 的条件编译

    // #ifdef  %PLATFORM%
    平台特有的API实现
    // #endif

示例,如下代码仅在App下出现:

示例,如下代码不会在H5平台上出现:


出错的图片链接: https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app- doc/06a79490-4f3c-11eb-b680-7980c8a877b8.png

除了支持单个平台的条件编译外,还支持多平台同时编译,使用||来分隔平台名称。

示例,如下代码会在AppH5平台上出现:


出错的图片链接: https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app- doc/05c1ef80-4f3c-11eb-b680-7980c8a877b8.png

组件的条件编译

    <!--  #ifdef  %PLATFORM% -->
    平台特有的组件
    <!--  #endif -->

示例,如下公众号关注组件仅会在微信小程序中出现:

    <view>
      <view>微信公众号关注组件</view>
      <view>
        <!-- #ifdef MP-WEIXIN -->
        <official-account></official-account>
        <!-- #endif -->
      </view>
    </view>

样式的条件编译

    /*  #ifdef  %PLATFORM%  */
    平台特有样式
    /*  #endif  */

注意: 样式的条件编译,无论是 css 还是 sass/scss/less/stylus 等预编译语言中,必须使用 /*注释*/ 的写法。

正确写法


出错的图片链接: https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app- doc/0bd78d80-4f3c-11eb-a16f-5b3e54966275.png

错误写法


出错的图片链接: https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app- doc/0c9c8b30-4f3c-11eb-8a36-ebb87efcf8c0.png

pages.json 的条件编译

下面的页面,只有运行至App时才会编译进去。


出错的图片链接: https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app- doc/04ecec40-4f3c-11eb-97b7-0dc4655d6e68.png

不同平台下的特有功能,以及小程序平台的分包,都可以通过 pages.json 的条件编译来更好地实现。这样,就不会在其它平台产生多余的资源,进而减小包体积。

json的条件编译,如不同平台的key名称相同,cli项目下开发者自己安装的校验器会报错,需自行关闭这些校验器对json相同key的校验规则。如果使用HBuilderX的校验器,无需在意此问题,HBuilderX的语法校验器为此优化过

static 目录的条件编译

在不同平台,引用的静态资源可能也存在差异,通过 static 的的条件编译可以解决此问题,static 目录下新建不同平台的专有目录(目录名称同%PLATFORM%值域,但字母均为小写),专有目录下的静态资源只有在特定平台才会编译进去。

如以下目录结构,a.png只有在微信小程序平台才会编译进去,b.png在所有平台都会被编译。

    ┌─static                
    │  ├─mp-weixin
    │  │  └─a.png     
    │  └─b.png
    ├─main.js        
    ├─App.vue      
    ├─manifest.json 
    └─pages.json 

整体目录条件编译

如果想把各平台的页面文件更彻底的分开,也可以在test-app项目根目录创建platforms目录,然后在下面进一步创建app-plusmp- weixin等子目录,存放不同平台的文件。

platforms目录下只支持放置页面文件(即页面vue文件),如果需要对其他资源条件编译建议使用static 目录的条件编译

下拉刷新

pages.json设置对应页面enablePullDownRefresh属性,激活下拉。

    {
    	"path": "pages/pull_down/index",
    	"style": {
    		"navigationBarTitleText": "下拉测试",
    		"enablePullDownRefresh":true
    	}
    }
    <template>
      <view>
        {{ text }}
      </view>
    </template>
    
    <script>
      // 仅做示例,实际开发中延时根据需求来使用。
      export default {
        data() {
          return {
            text: 'test-app'
          }
        },
        onLoad: function(options) {
          setTimeout(function() {
            console.log('start pulldown');
          }, 1000);
          uni.startPullDownRefresh();
        },
        onPullDownRefresh() {
          console.log('refresh');
          setTimeout(function() {
            uni.stopPullDownRefresh();
          }, 1000);
        }
      }
    </script>

onPullDownRefresh

在 js 中定义onPullDownRefresh处理函数(和onLoad等生命周期函数同级),监听该页面用户下拉刷新事件。

  • 需要在pages.json里,找到的当前页面的pages节点,并在style选项中开启enablePullDownRefresh
  • 当处理完数据刷新后,uni.stopPullDownRefresh可以停止当前页面的下拉刷新

uni.startPullDownRefresh(OBJECT)

开始下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。

OBJECT 参数说明

参数名类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

属性类型描述
errMsgString接口调用结果

uni.stopPullDownRefresh()

停止当前页面下拉刷新。

###数据缓存

uni.setStorage(OBJECT)

将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个异步接口。

OBJECT 参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key
dataAny需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

代码示例

    uni.setStorage({
    	key: 'storage_key',
    	data: 'hello',
    	success: function () {
    		console.log('success');
    	}
    });

uni-uni_dcloud-dcloud_为前缀的key,为系统保留关键前缀。如uni_deviceIduni_id_token,请开发者为key命名时避开这些前缀。

uni.setStorageSync(KEY,DATA)

将 data 存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个同步接口。

参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key
dataAny需要存储的内容,只支持原生类型、及能够通过 JSON.stringify 序列化的对象

代码示例

    try {
    	uni.setStorageSync('storage_key', 'hello');
    } catch (e) {
    	// error
    }

uni.getStorage(OBJECT)

从本地缓存中异步获取指定 key 对应的内容。

OBJECT 参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key
successFunction接口调用的回调函数,res = {data: key对应的内容}
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

代码示例

    uni.getStorage({
    	key: 'storage_key',
    	success: function (res) {
    		console.log(res.data);
    	}
    });

uni.getStorageSync(KEY)

从本地缓存中同步获取指定 key 对应的内容。

参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key

代码示例

    try {
    	const value = uni.getStorageSync('storage_key');
    	if (value) {
    		console.log(value);
    	}
    } catch (e) {
    	// error
    }

uni.getStorageInfo(OBJECT)

异步获取当前 storage 的相关信息。

OBJECT 参数说明

参数名类型必填说明
successFunction接口调用的回调函数,详见返回参数说明
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数名类型说明
keysArray<String>当前 storage 中所有的 key
currentSizeNumber当前占用的空间大小, 单位:kb
limitSizeNumber限制的空间大小, 单位:kb

代码示例

    uni.getStorageInfo({
    	success: function (res) {
    		console.log(res.keys);
    		console.log(res.currentSize);
    		console.log(res.limitSize);
    	}
    });

uni.getStorageInfoSync()

同步获取当前 storage 的相关信息。

代码示例

    try {
    	const res = uni.getStorageInfoSync();
    	console.log(res.keys);
    	console.log(res.currentSize);
    	console.log(res.limitSize);
    } catch (e) {
    	// error
    }

uni.removeStorage(OBJECT)

从本地缓存中异步移除指定 key。

OBJECT 参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key
successFunction接口调用的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

代码示例

    uni.removeStorage({
    	key: 'storage_key',
    	success: function (res) {
    		console.log('success');
    	}
    });

uni.removeStorageSync(KEY)

从本地缓存中同步移除指定 key。

参数说明

参数名类型必填说明
keyString本地缓存中的指定的 key

代码示例

    try {
    	uni.removeStorageSync('storage_key');
    } catch (e) {
    	// error
    }

uni.clearStorage()

清理本地数据缓存。

代码示例

    uni.clearStorage();

uni.clearStorageSync()

同步清理本地数据缓存。

代码示例

    try {
    	uni.clearStorageSync();
    } catch (e) {
    	// error
    }

自定义头部

pages.json 中设置去掉原生头部

navigationStyle设为customtitleNView设为false时,原生导航栏不显示。

    {
      "pages": [{
          "path": "pages/index/index",
          "style": {
            "navigationBarTitleText": "首页",
            // 单个页面设置
            "navigationStyle": "custom"
            /* "app-plus": {
            	"titleNView": false
            } */
          }
        },
        {
          "path": "pages/index/list-news",
          "style": {
            "navigationBarTitleText": "新闻"
          }
        }
      ],
      "globalStyle": {
        "navigationBarTextStyle": "black",
        "navigationBarTitleText": "uni-app",
        "navigationBarBackgroundColor": "#F8F8F8",
        "backgroundColor": "#F8F8F8",
        // 全局设置
        "navigationStyle": "custom"
        /* "app-plus":{
        	"titleNView":false
        } */
      }
    }

状态栏 占位div

非H5端,手机顶部状态栏区域会被页面内容覆盖。这是因为窗体是沉浸式的原因,即全屏可写内容。uni-app提供了状态栏高度的css变量--status- bar-height,如果需要把状态栏的位置从前景部分让出来,可写一个占位div,高度设为css变量。

使用css方式进行控制

    <template>
      <view>
        <view class="status_bar">
          <!-- 这里是状态栏 -->
        </view>
        <view> 状态栏下的文字 </view>
      </view>
    </template>
    <style>
      .status_bar {
        height: var(--status-bar-height);
        width: 100%;
      }
    </style>

使用js方式进行控制

    <template>
      <view>
        <view :style="'height:'+statusHeight+'px'">
          <!-- 这里是状态栏 -->
        </view>
        <text> 状态栏下的文字 </text>
      </view>
    </template>
    <script>
      export default {
        data() {
          return {
            statusHeight: 0
          }
        },
        onLoad() {
          this.statusHeight = plus.navigator.getStatusbarHeight();
        }
      }
    </script>

事件监听注册

uniapp 提供了事件的监听注册以及触发,注册的事件都是 App 全局级别的,可以很方便的跨任意组件,页面,nvue,vue 等。

相关注册或触发函数

uni.$emit(eventName,OBJECT)

触发全局的自定义事件,附加参数都会传给监听器回调函数。

属性类型描述
eventNameString事件名
OBJECTObject触发事件携带的附加参数

代码示例

    uni.$emit('update',{msg:'页面更新'})

uni.$on(eventName,callback)

监听全局的自定义事件,事件由uni.$emit触发,回调函数会接收事件触发函数的传入参数。

属性类型描述
eventNameString事件名
callbackFunction事件的回调函数

代码示例

    uni.$on('update',function(data){
      console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    })

uni.$once(eventName,callback)

监听全局的自定义事件,事件由uni.$emit触发,但仅触发一次,在第一次触发之后移除该监听器。

属性类型描述
eventNameString事件名
callbackFunction事件的回调函数

代码示例

    uni.$once('update',function(data){
      console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    })

uni.$off([eventName, callback])

移除全局自定义事件监听器。

属性类型描述
eventNameArray<String>事件名
callbackFunction事件的回调函数
  • 如果uni.$off没有传入参数,则移除App级别的所有事件监听器;
  • 如果只提供了事件名(eventName),则移除该事件名对应的所有监听器;
  • 如果同时提供了事件与回调,则只移除这个事件回调的监听器;
  • 提供的回调必须跟$on的回调为同一个才能移除这个回调的监听器

代码示例

$emit$on$off常用于跨页面、跨组件通讯,这里为了方便演示放在同一个页面

    <template>
      <view class="content">
        <view class="data">
          <text>{{val}}</text>
        </view>
        <button type="primary" @click="comunicationOff">结束监听</button>
      </view>
    </template>
    
    <script>
      export default {
        data() {
          return {
            val: 0
          }
        },
        onLoad() {
          setInterval(() => {
            uni.$emit('add', {
              data: 2
            })
          }, 1000)
          uni.$on('add', this.add)
        },
        methods: {
          comunicationOff() {
            uni.$off('add', this.add)
          },
          add(e) {
            this.val += e.data
          }
        }
      }
    </script>
    
    <style>
      .content {
        display: flex;
        flex-direction: column;
        align-items: center;
        justify-content: center;
      }
    
      .data {
        text-align: center;
        line-height: 40px;
        margin-top: 40px;
      }
    
      button {
        width: 200px;
        margin: 20px 0;
      }
    </style>
  • uni.$emit、 uni.$on 、 uni.$once 、uni.$off 触发的事件都是 App 全局级别的,跨任意组件,页面,nvue,vue 等
  • 使用时,注意及时销毁事件监听,比如,页面 onLoad 里边 uni.$on 注册监听,onUnload 里边 uni.$off 移除,或者一次性的事件,直接使用 uni.$once 监听
  • 注意 uni.$on 定义完成后才能接收到 uni.$emit 传递的数据

场景案例

我们假设一个场景,进入app,是未登陆状态,需要在我的页面点击登陆,进入登陆页面进行登陆。登陆成功之后,返回到我的页面,实时显示登陆后的用户信息。

监听事件

在用户中心页面 监听事件。因为事件监听是全局的,所以使用uni.$on,需要使用uni.$off移除全局的事件监听,避免重复监听。

    <template>
      <view class="content">
        <navigator url="/pages/login/index" hover-class="navigator-hover">
          <button type="default">点我登录</button>
        </navigator>
        <view v-if="usnerInfo !== null">
          <view>
            用户token:{{usnerInfo.token}},用户昵称:{{usnerInfo.nickName}}
          </view>
        </view>
      </view>
    </template>
    
    <script>
      export default {
        data() {
          return {
            usnerInfo: null
          }
        },
        onLoad() {
          // 监听事件
          console.log('on login....');
          uni.$on('login', (uinfo) => {
            this.usnerInfo = uinfo;
          })
        },
        onUnload() {
          // 移除监听事件
          console.log('off login....');
          uni.$off('login');
        },
        methods: {
    
        }
      }
    </script>

触发事件

进入登陆页面,触发事件。使用uni.$emit触发事件后,对应的uni.$on就会监听到事件触发,在回调中去执行相关的逻辑。

    <template>
      <view>
        <button type="default" @click="login">登录</button>
      </view>
    </template>
    
    <script>
      export default {
        data() {
          return {};
        },
        methods: {
          login() {
            // 假设用户登录成功,此时调用emit方法触发监听事件,刷新用户登录信息
            uni.$emit('login', {
              token: 'user123456',
              nickName: 'wk123',
            });
          }
        }
      }
    </script>

基本上述场景均可以实现,本质上就是一个页面通知另一个面我发生了变化,你需要处理一下。绝大部分页面的通讯都可以使用uni.$emituni.$onuni.$onceuni.$off四个事件完成

2 Uniapp页面组成

页面简介

uni-app项目中,一个页面就是一个符合Vue SFC规范的.vue文件或.nvue文件。

.vue页面和.nvue页面,均全平台支持,差异在于当uni- app发行到App平台时,.vue文件会使用webview进行渲染,.nvue会使用原生进行渲染

新建页面

uni-app中的页面,通常会保存在工程根目录下的pages目录下。

每次新建页面,均需在pages.json中配置pages列表;未在pages.json -> pages 中配置的页面,uni-app会在编译阶段进行忽略

通过HBuilderX开发 uni-app 项目时,在 uni-app 项目上右键“新建页面”,HBuilderX会自动在pages.json中完成页面注册,开发更方便。

同时,HBuilderX 还内置了常用的页面模板(如图文列表、商品列表等),选择这些模板,可以大幅提升你的开发效率。

删除页面

删除页面时,需做两件工作:

  • 删除.vue文件或.nvue文件
  • 删除pages.json -> pages列表项中的配置

应用首页

uni-app会将pages.json -> pages配置项中的第一个页面,作为当前工程的首页(启动页)

页面生命周期

函数名说明平台差异说明最低版本
onInit监听页面初始化,其参数同 onLoad 参数,为上个页面传递的数据,参数类型为 Object(用于页面传参),触发时机早于 onLoad百度小程序3.1.0+
onLoad监听页面加载,其参数为上个页面传递的数据,参数类型为 Object(用于页面传参),参考示例 (opens new window)
onShow监听页面显示。页面每次出现在屏幕上都触发,包括从下级页面点返回露出当前页面
onReady监听页面初次渲染完成。注意如果渲染速度快,会在页面进入动画完成前触发
onHide监听页面隐藏
onUnload监听页面卸载
onResize监听窗口尺寸变化App、微信小程序、快手小程序
onPullDownRefresh监听用户下拉动作,一般用于下拉刷新,参考示例 (opens new window)
onReachBottom页面滚动到底部的事件(不是scroll-view滚到底),常用于下拉下一页数据。具体见下方注意事项
onTabItemTap点击 tab 时触发,参数为Object,具体见下方注意事项微信小程序、QQ小程序、支付宝小程序、百度小程序、H5、App、快手小程序、京东小程序
onShareAppMessage用户点击右上角分享微信小程序、QQ小程序、支付宝小程序、字节小程序、飞书小程序、快手小程序、京东小程序
onPageScroll监听页面滚动,参数为Objectnvue暂不支持
onNavigationBarButtonTap监听原生标题栏按钮点击事件,参数为ObjectApp、H5
onBackPress监听页面返回,返回 event = {from:backbutton、 navigateBack} ,backbutton 表示来源是左上角返回按钮或 android 返回键;navigateBack表示来源是 uni.navigateBack ;详细说明及使用:onBackPress 详解 (opens new window)。支付宝小程序只有真机能触发,只能监听非navigateBack引起的返回,不可阻止默认行为。app、H5、支付宝小程序
onNavigationBarSearchInputChanged监听原生标题栏搜索输入框输入内容变化事件App、H51.6.0
onNavigationBarSearchInputConfirmed监听原生标题栏搜索输入框搜索事件,用户点击软键盘上的“搜索”按钮时触发。App、H51.6.0
onNavigationBarSearchInputClicked监听原生标题栏搜索输入框点击事件(pages.json 中的 searchInput 配置 disabled 为 true 时才会触发)App、H51.6.0
onShareTimeline监听用户点击右上角转发到朋友圈微信小程序2.8.1+
onAddToFavorites监听用户点击右上角收藏微信小程序、QQ小程序2.8.1+

onInit使用注意

  • 仅百度小程序基础库 3.260 以上支持 onInit 生命周期
  • 其他版本或平台可以同时使用 onLoad 生命周期进行兼容,注意避免重复执行相同逻辑
  • 不依赖页面传参的逻辑可以直接使用 created 生命周期替代

onInit使用注意

  • 仅百度小程序基础库 3.260 以上支持 onInit 生命周期
  • 其他版本或平台可以同时使用 onLoad 生命周期进行兼容,注意避免重复执行相同逻辑
  • 不依赖页面传参的逻辑可以直接使用 created 生命周期替代

onReachBottom使用注意 可在pages.json里定义具体页面底部的触发距离onReachBottomDistance (opens new window),比如设为50,那么滚动页面到距离底部50px时,就会触发onReachBottom事件。

如使用scroll-view导致页面没有滚动,则触底事件不会被触发。scroll-view滚动到底部的事件请参考scroll-view的文档

onPageScroll (监听滚动、滚动监听、滚动事件)参数说明:

属性类型说明
scrollTopNumber页面在垂直方向已滚动的距离(单位px)

注意

  • onPageScroll里不要写交互复杂的js,比如频繁修改页面。因为这个生命周期是在渲染层触发的,在非h5端,js是在逻辑层执行的,两层之间通信是有损耗的。如果在滚动过程中,频发触发两层之间的数据交换,可能会造成卡顿。
  • 如果想实现滚动时标题栏透明渐变,在App和H5下,可在pages.json中配置titleNView下的type为transparent,参考 (opens new window)
  • 如果需要滚动吸顶固定某些元素,推荐使用css的粘性布局,参考插件市场 (opens new window)。插件市场也有其他js实现的吸顶插件,但性能不佳,需要时可自行搜索。
  • 在App、微信小程序、H5中,也可以使用wxs监听滚动,参考 (opens new window);在app-nvue中,可以使用bindingx监听滚动,参考 (opens new window)
  • onBackPress上不可使用async,会导致无法阻止默认返回
    onPageScroll : function(e) { //nvue暂不支持滚动监听,可用bindingx代替
    	console.log("滚动距离为:" + e.scrollTop);
    },

onTabItemTap 返回的json对象说明:

属性类型说明
indexNumber被点击tabItem的序号,从0开始
pagePathString被点击tabItem的页面路径
textString被点击tabItem的按钮文字

注意

  • onTabItemTap常用于点击当前tabitem,滚动或刷新当前页面。如果是点击不同的tabitem,一定会触发页面切换。
  • 如果想在App端实现点击某个tabitem不跳转页面,不能使用onTabItemTap,可以使用plus.nativeObj.view (opens new window)放一个区块盖住原先的tabitem,并拦截点击事件。
    onTabItemTap : function(e) {
    	console.log(e);
    	// e的返回格式为json对象: {"index":0,"text":"首页","pagePath":"pages/index/index"}
    },

onNavigationBarButtonTap 参数说明:

属性类型说明
indexNumber原生标题栏按钮数组的下标
    onNavigationBarButtonTap : function (e) {
    	console.log(e);
    	// e的返回格式为json对象:{"text":"测试","index":0}
    }

onBackPress 回调参数对象说明:

属性类型说明
fromString触发返回行为的来源:'backbutton'——左上角导航栏按钮及安卓返回键;'navigateBack'——uni.navigateBack() 方法。支付宝小程序端不支持返回此字段
    export default {
    	data() {
    		return {};
    	},
    	onBackPress(options) {
    		console.log('from:' + options.from)
    	}
    }

注意

  • nvue 页面weex编译模式支持的生命周期同weex,具体参考:weex生命周期介绍 (opens new window)
  • 支付宝小程序真机可以监听到非navigateBack引发的返回事件(使用小程序开发工具时不会触发onBackPress),不可以阻止默认返回行为

组件生命周期

uni-app 组件支持的生命周期,与vue标准组件的生命周期相同。这里没有页面级的onLoad等生命周期:

函数名说明平台差异说明最低版本
beforeCreate在实例初始化之前被调用。详见 (opens new window)
created在实例创建完成后被立即调用。详见 (opens new window)
beforeMount在挂载开始之前被调用。详见 (opens new window)
mounted挂载到实例上去之后调用。详见 (opens new window) 注意:此处并不能确定子组件被全部挂载,如果需要子组件完全挂载之后在执行操作可以使用$nextTickVue官方文档 (opens new window)
beforeUpdate数据更新时调用,发生在虚拟 DOM 打补丁之前。详见 (opens new window)仅H5平台支持
updated由于数据更改导致的虚拟 DOM 重新渲染和打补丁,在这之后会调用该钩子。详见 (opens new window)仅H5平台支持
beforeDestroy实例销毁之前调用。在这一步,实例仍然完全可用。详见 (opens new window)
destroyedVue 实例销毁后调用。调用后,Vue 实例指示的所有东西都会解绑定,所有的事件监听器会被移除,所有的子实例也会被销毁。详见 (opens new window)

页面调用接口

getApp()

getApp() 函数用于获取当前应用实例,一般用于获取globalData 。

实例

    const app = getApp()
    console.log(app.globalData)

注意:

  • 不要在定义于 App() 内的函数中,或调用 App 前调用 getApp() ,可以通过 this.$scope 获取对应的app实例
  • 通过 getApp() 获取实例之后,不要私自调用生命周期函数。
  • 当在首页nvue中使用getApp()不一定可以获取真正的App对象。对此提供了const app = getApp({allowDefault: true})用来获取原始的App对象,可以用来在首页对globalData等初始化

getCurrentPages()

getCurrentPages() 函数用于获取当前页面栈的实例,以数组形式按栈的顺序给出,第一个元素为首页,最后一个元素为当前页面。

注意: getCurrentPages()仅用于展示页面栈的情况,请勿修改页面栈,以免造成页面状态错误。

每个页面实例的方法属性列表:

方法描述平台说明
page.$getAppWebview()获取当前页面的webview对象实例App
page.route获取当前页面的路由

Tips:

  • navigateTo, redirectTo 只能打开非 tabBar 页面。
  • switchTab 只能打开 tabBar 页面。
  • reLaunch 可以打开任意页面。
  • 页面底部的 tabBar 由页面决定,即只要是定义为 tabBar 的页面,底部都有 tabBar
  • 不能在 App.vue 里面进行页面跳转。

$getAppWebview()

uni-appgetCurrentPages()获得的页面里内置了一个方法 $getAppWebview() 可以得到当前webview的对象实例,从而实现对 webview 更强大的控制。在 html5Plus 中,plus.webview具有强大的控制能力,可参考:WebviewObject (opens new window)

uni-app框架有自己的窗口管理机制,请不要自己创建和销毁webview,如有需求覆盖子窗体上去,请使用原生子窗体subNvue (opens new window)

注意:此方法仅 App 支持

示例:

获取当前页面 webview 的对象实例

    export default {
      data() {
        return {
          title: 'Hello'
        }
      },
      onLoad() {
        // #ifdef APP-PLUS
        const currentWebview = this.$scope.$getAppWebview(); //此对象相当于html5plus里的plus.webview.currentWebview()。在uni-app里vue页面直接使用plus.webview.currentWebview()无效
        currentWebview.setBounce({position:{top:'100px'},changeoffset:{top:'0px'}}); //动态重设bounce效果
        // #endif
      }
    }

获取指定页面 webview 的对象实例

getCurrentPages()可以得到所有页面对象,然后根据数组,可以取指定的页面webview对象

    var pages = getCurrentPages();
    var page = pages[pages.length - 1];
    // #ifdef APP-PLUS
    var currentWebview = page.$getAppWebview();
    console.log(currentWebview.id);//获得当前webview的id
    console.log(currentWebview.isVisible());//查询当前webview是否可见
    );
    // #endif

uni-app自带的web-view组件,是页面中新插入的一个子webview

页面通讯

uni.$emit(eventName,OBJECT)

触发全局的自定义事件。附加参数都会传给监听器回调。

属性类型描述
eventNameString事件名
OBJECTObject触发事件携带的附加参数

代码示例

    	uni.$emit('update',{msg:'页面更新'})

uni.$on(eventName,callback)

监听全局的自定义事件。事件可以由 uni.$emit 触发,回调函数会接收所有传入事件触发函数的额外参数。

属性类型描述
eventNameString事件名
callbackFunction事件的回调函数

代码示例

    	uni.$on('update',function(data){
    		console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    	})

uni.$once(eventName,callback)

监听全局的自定义事件。事件可以由 uni.$emit 触发,但是只触发一次,在第一次触发之后移除监听器。

属性类型描述
eventNameString事件名
callbackFunction事件的回调函数

代码示例

    	uni.$once('update',function(data){
    		console.log('监听到事件来自 update ,携带参数 msg 为:' + data.msg);
    	})

uni.$off([eventName, callback])

移除全局自定义事件监听器。

属性类型描述
eventNameArray<String>事件名
callbackFunction事件的回调函数

Tips

  • 如果没有提供参数,则移除所有的事件监听器;
  • 如果只提供了事件,则移除该事件所有的监听器;
  • 如果同时提供了事件与回调,则只移除这个回调的监听器;
  • 提供的回调必须跟$on的回调为同一个才能移除这个回调的监听器;

代码示例

$emit$on$off常用于跨页面、跨组件通讯,这里为了方便演示放在同一个页面

    <template>
    		<view class="content">
    			<view class="data">
    				<text>{{val}}</text>
    			</view>
    			<button type="primary" @click="comunicationOff">结束监听</button>
    		</view>
    	</template>
    
    	<script>
    		export default {
    			data() {
    				return {
    					val: 0
    				}
    			},
    			onLoad() {
    				setInterval(()=>{
    					uni.$emit('add', {
    						data: 2
    					})
    				},1000)
    				uni.$on('add', this.add)
    			},
    			methods: {
    				comunicationOff() {
    					uni.$off('add', this.add)
    				},
    				add(e) {
    					this.val += e.data
    				}
    			}
    		}
    	</script>
    
    	<style>
    		.content {
    			display: flex;
    			flex-direction: column;
    			align-items: center;
    			justify-content: center;
    		}
    
    		.data {
    			text-align: center;
    			line-height: 40px;
    			margin-top: 40px;
    		}
    
    		button {
    			width: 200px;
    			margin: 20px 0;
    		}
    	</style>

注意事项

  • uni.$emit、 uni.$on 、 uni.$once 、uni.$off 触发的事件都是 App 全局级别的,跨任意组件,页面,nvue,vue 等
  • 使用时,注意及时销毁事件监听,比如,页面 onLoad 里边 uni.$on 注册监听,onUnload 里边 uni.$off 移除,或者一次性的事件,直接使用 uni.$once 监听

路由

uni-app页面路由为框架统一管理,开发者需要在pages.json (opens new window)里配置每个路由页面的路径及页面样式。类似小程序在 app.json 中配置页面路由一样。所以 uni-app 的路由用法与 Vue Router 不同,如仍希望采用 Vue Router 方式管理路由,可在插件市场搜索 Vue-Router (opens new window)

uni-app 有两种页面路由跳转方式:使用navigator (opens new window)组件跳转、调用API (opens new window)跳转

    <template>
    	<view>
    		<view class="page-body">
    			<view class="btn-area">
    				<navigator url="navigate/navigate?title=navigate" hover-class="navigator-hover">
    					<button type="default">跳转到新页面</button>
    				</navigator>
    				<navigator url="redirect/redirect?title=redirect" open-type="redirect" hover-class="other-navigator-hover">
    					<button type="default">在当前页打开</button>
    				</navigator>
    				<navigator url="/pages/tabBar/extUI/extUI" open-type="switchTab" hover-class="other-navigator-hover">
    					<button type="default">跳转tab页面</button>
    				</navigator>
    			</view>
    		</view>
    	</view>
    </template>
    <script>
    // navigate.vue页面接受参数
    export default {
    	onLoad: function (option) { //option为object类型,会序列化上个页面传递的参数
    		console.log(option.id); //打印出上个页面传递的参数。
    		console.log(option.name); //打印出上个页面传递的参数。
    	}
    }
    </script>

uni.navigateTo(OBJECT)

    //在起始页面跳转到test.vue页面并传递参数
    uni.navigateTo({
    	url: 'test?id=1&name=uniapp'
    });
    // 在test.vue页面接受参数
    export default {
    	onLoad: function (option) { //option为object类型,会序列化上个页面传递的参数
    		console.log(option.id); //打印出上个页面传递的参数。
    		console.log(option.name); //打印出上个页面传递的参数。
    	}
    }

页面栈

框架以栈的形式管理当前所有页面, 当发生路由切换的时候,页面栈的表现如下

框架以栈的形式管理当前所有页面, 当发生路由切换的时候,页面栈的表现如下:

路由方式页面栈表现触发时机
初始化新页面入栈uni-app 打开的第一个页面
打开新页面新页面入栈调用 API uni.navigateTo (opens new window) 、使用组件 <navigator open-type="navigate"/>
页面重定向当前页面出栈,新页面入栈调用 API uni.redirectTo (opens new window) 、使用组件 <navigator open-type="redirectTo"/>
页面返回页面不断出栈,直到目标返回页调用 API uni.navigateBack (opens new window) 、使用组件 <navigator open-type="navigateBack"/> 、用户按左上角返回按钮、安卓用户点击物理back按键
Tab 切换页面全部出栈,只留下新的 Tab 页面调用 API uni.switchTab (opens new window) 、使用组件 <navigator open-type="switchTab"/> 、用户切换 Tab
重加载页面全部出栈,只留下新的页面调用 API uni.reLaunch (opens new window) 、使用组件 <navigator open-type="reLaunch"/>

页面代码规范介绍

uni-app 支持在 template 模板中嵌套 <template/><block/>,用来进行 列表渲染 (opens new window) 和 [条件渲染 (opens new window)](https://uniapp.dcloud.net.cn/tutorial/vue- basics#condition)。

<template/><block/> 并不是一个组件,它们仅仅是一个包装元素,不会在页面中做任何渲染,只接受控制属性。

<block/> 在不同的平台表现存在一定差异,推荐统一使用 <template/>

    <template>
    	<view>
    		<template v-if="test">
    			<view>test 为 true 时显示</view>
    		</template>
    		<template v-else>
    			<view>test 为 false 时显示</view>
    		</template>
    	</view>
    </template>
    <template>
    	<view>
    		<block v-for="(item,index) in list" :key="index">
    			<view>{{item}} - {{index}}</view>
    		</block>
    	</view>
    </template>

nvue 开发与 vue 开发的常见区别

nvue是什么?native vue的缩写

Nvue是一个基于weex改进的原生渲染引擎,它在某些方面要比vue更高性能,在app上使用更加流畅,但是缺点也很明显,没有足够的api能力,语法限制太大,所以nvue适用于特定场景

  • nvue 是 uni-app 的一种渲染方式,如果使用vue页面,则使用webview渲染;如果使用nvue页面(native vue的缩写),则使用原生渲染
  • nvue 页面控制显隐只可以使用v-if不可以使用v-show
  • nvue 页面只能使用flex布局,不支持其他布局方式。页面开发前,首先想清楚这个页面的纵向内容有什么,哪些是要滚动的,然后每个纵向内容的横轴排布有什么,按 flex 布局设计好界面
  • nvue 页面的布局排列方向默认为竖排(column),如需改变布局方向,可以在 manifest.json -> app-plus -> nvue -> flex-direction 节点下修改,仅在 uni-app 模式下生效
  • nvue 页面编译为 H5、小程序时,会做一件 css 默认值对齐的工作。因为 weex 渲染引擎只支持 flex,并且默认 flex 方向是垂直。而 H5 和小程序端,使用 web 渲染,默认不是 flex,并且设置display:flex后,它的 flex 方向默认是水平而不是垂直的。所以 nvue 编译为 H5、小程序时,会自动把页面默认布局设为 flex、方向为垂直。当然开发者手动设置后会覆盖默认设置
  • 文字内容,必须、只能在<text>组件下。不能在<div><view>text区域里直接写文字。否则即使渲染了,也无法绑定 js 里的变量
  • 只有text标签可以设置字体大小,字体颜色
  • 布局不能使用百分比、没有媒体查询
  • nvue 切换横竖屏时可能导致样式出现问题,建议有 nvue 的页面锁定手机方向
  • 支持的 css 有限,不过并不影响布局出你需要的界面,flex还是非常强大的
  • 不支持背景图。但可以使用image组件和层级来实现类似 web 中的背景效果。因为原生开发本身也没有 web 这种背景图概念
  • css 选择器支持的比较少,只能使用 class 选择器
  • nvue 的各组件在安卓端默认是透明的,如果不设置background-color,可能会导致出现重影的问题
  • class 进行绑定时只支持数组语法
  • Android 端在一个页面内使用大量圆角边框会造成性能问题,尤其是多个角的样式还不一样的话更耗费性能。应避免这类使用
  • nvue 页面没有bounce回弹效果,只有几个列表组件有bounce效果,包括 listrecycle-listwaterfall
  • 原生开发没有页面滚动的概念,页面内容高过屏幕高度并不会自动滚动,只有部分组件可滚动(listwaterfallscroll-view/scroller),要滚得内容需要套在可滚动组件下。这不符合前端开发的习惯,所以在 nvue 编译为 uni-app 模式时,给页面外层自动套了一个 scroller,页面内容过高会自动滚动。(组件不会套,页面有recycle-list时也不会套)。后续会提供配置,可以设置不自动套
  • App.vue 中定义的全局 js 变量不会在 nvue 页面生效。globalDatavuex是生效的
  • App.vue 中定义的全局 css,对 nvue 和 vue 页面同时生效。如果全局 css 中有些 css 在 nvue 下不支持,编译时控制台会报警,建议把这些不支持的 css 包裹在条件编译 (opens new window)里,APP-PLUS-NVUE
  • 不能在 style 中引入字体文件,nvue 中字体图标的使用参考:加载自定义字体 (opens new window)。如果是本地字体,可以用plus.io的 API 转换路径
  • 目前不支持在 nvue 页面使用 typescript/ts

3 资源互相引用

NPM支持

在项目根目录执行命令安装npm包:

    npm install packageName --save

使用

安装完即可使用npm包,js中引入npm包:

    import package from 'packageName'
    const package = require('packageName')

模板内引入静态资源

template内引入静态资源,如imagevideo等标签的src属性时,可以使用相对路径或者绝对路径,形式如下

    <!-- 绝对路径,/static指根目录下的static目录,在cli项目中/static指src目录下的static目录 -->
    <image class="logo" src="/static/logo.png"></image>
    <image class="logo" src="@/static/logo.png"></image>
    <!-- 相对路径 -->
    <image class="logo" src="../../static/logo.png"></image>

注意

  • @开头的绝对路径以及相对路径会经过 base64 转换规则校验
  • 引入的静态资源在非 h5 平台,均不转为 base64
  • H5 平台,小于 4kb 的资源会被转换成 base64,其余不转。
  • HBuilderX 2.6.6template内支持@开头路径引入静态资源,旧版本不支持此方式
  • App 平台自HBuilderX 2.6.9template节点中引用静态资源文件时(如:图片),调整查找策略为【基于当前文件的路径搜索】,与其他平台保持一致
  • 支付宝小程序组件内 image 标签不可使用相对路径

css 引入静态资源

css文件或style标签内引入css文件时(scss、less 文件同理),可以使用相对路径或绝对路径(HBuilderX 2.6.6

    /* 绝对路径 */
    @import url('/common/uni.css');
    @import url('@/common/uni.css');
    /* 相对路径 */
    @import url('../../common/uni.css');

注意

  • HBuilderX 2.6.6起支持绝对路径引入静态资源,旧版本不支持此方式

css文件或style标签内引用的图片路径可以使用相对路径也可以使用绝对路径,需要注意的是,有些小程序端 css 文件不允许引用本地文件(请看注意事项)。

    /* 绝对路径 */
    background-image: url(/static/logo.png);
    background-image: url(@/static/logo.png);
    /* 相对路径 */
    background-image: url(../../static/logo.png);

Tips

  • 引入字体图标请参考,字体图标 (opens new window)
  • @开头的绝对路径以及相对路径会经过 base64 转换规则校验
  • 不支持本地图片的平台,小于 40kb,一定会转 base64。(共四个平台 mp-weixin, mp-qq, mp-toutiao, app v2)
  • h5 平台,小于 4kb 会转 base64,超出 4kb 时不转。
  • 其余平台不会转 base64

引入原生插件

    const PluginName = uni.requireNativePlugin(PluginName); // PluginName 为原生插件名称

内置原生插件

内置原生插件,uni-app已默认集成,支持直接在内置基座运行。

仅在nvue页面,支持引入BindingX,animation, DOM.addRule等。

在vue页面,支持引入clipboard,storage,stream,deviceInfo等。

使用方式:可通过uni.requireNativePlugin直接使用。

    <template>
    		<view>
    			<text class="my-iconfont">&#xe85c;</text>	
    		</view>
    	</template>
    	<script>
    		export default{
    			beforeCreate() {
    				const domModule = uni.requireNativePlugin('dom')
    				domModule.addRule('fontFace', {
    					'fontFamily': "myIconfont",
    					'src': "url('http://at.alicdn.com/t/font_2234252_v3hj1klw6k9.ttf')"
    				});
    			}
    		}
    	</script>
    	<style>
    		.my-iconfont {
    			font-family:myIconfont;
    			font-size:60rpx;
    			color: #00AAFF;
    		}
    	</style>

非内置原生插件,分为 [本地插件 (opens new window)](https://uniapp.dcloud.net.cn/api/extend/native- plugin#%E6%9C%AC%E5%9C%B0%E6%8F%92%E4%BB%B6%E9%9D%9E%E5%86%85%E7%BD%AE%E5%8E%9F%E7%94%9F%E6%8F%92%E4%BB%B6) 和 [云端插件 (opens new window)](https://uniapp.dcloud.net.cn/api/extend/native- plugin#%E4%BA%91%E7%AB%AF%E6%8F%92%E4%BB%B6%E9%9D%9E%E5%86%85%E7%BD%AE%E5%8E%9F%E7%94%9F%E6%8F%92%E4%BB%B6) 。集成原生插件后,需要提交云端打包或制作自定义基座运行才会生效

本地插件(非内置原生插件)

本地插件 ,是uni-app项目nativeplugins目录(目录不存在则创建)下的原生插件

第一步:获取本地原生插件
  • 方式一:插件市场下载免费uni-app原生插件

可以登录uni原生插件市场 (opens new window),在免费的插件详情页中点击“下载for离线打包”下载原生插件(zip格式),解压到HBuilderX的uni- app项目下的“nativeplugins”目录(如不存在则创建),以下是“DCloud- RichAlert”插件举例,它的下载地址是:https://ext.dcloud.net.cn/plugin?id=36

下载解压后目录结构如下:

  • 方式二:开发者自己开发uni-app原生插件

原生插件开发完成后按指定格式压缩为zip包,参考uni-app原生插件格式说明文档 (opens new window)。 按上图的格式配置到uni-app项目下的“nativeplugins”目录

第二步:配置本地原生插件

在manifest.json -> App原生插件配置 -> 选择本地插件 -> 选择需要打包生效的插件 -> 保存后提交云端打包生效。

第三步:开发调试本地原生插件

在vue页面或nvue页面引入这个原生插件。

使用uni.requireNativePlugin的api,参数为插件的id。

    	const dcRichAlert = uni.requireNativePlugin('DCloud-RichAlert')
第四步:打包发布

使用自定义基座开发调试本地原生插件后,不可直接将自定义基座apk作为正式版发布。 应该重新提交云端打包(不能勾选“自定义基座”)生成正式版本。

云端插件(非内置原生插件)

云端插件 ,已经在插件市场绑定或购买的插件,无需下载插件到工程中,云打包时会直接合并打包原生插件到APP中。(试用插件只能在自定义基座中使用)

第一步:购买或下载uni-app原生插件

使用前需先登录uni原生插件市场 (opens new window),在插件详情页中购买,免费插件也可以在插件市场0元购。购买后才能够云端打包使用插件。

购买插件时请选择正确的appid,以及绑定正确包名

第二步:使用自定义基座打包uni原生插件 (注:请使用真机运行自定义基座)

在manifest.json -> App原生插件配置 -> 选择云端插件 -> 选择需要打包的插件 -> 保存后提交云端打包生效。

第三步:开发调试uni-app原生插件

在vue页面或nvue页面引入这个原生插件。

使用uni.requireNativePlugin的api,参数为插件的id。

1.在页面引入原生插件,uni.requireNativePlugin 使用后返回一个对象:

    const dcRichAlert = uni.requireNativePlugin('DCloud-RichAlert')

2.使用原生插件

    	dcRichAlert.show({
    		position: 'bottom',
    		title: "提示信息",
    		titleColor: '#FF0000',
    		content: "<a href='https://uniapp.dcloud.io/' value='Hello uni-app'>uni-app</a> 是一个使用 Vue.js 开发跨平台应用的前端框架!\n免费的\n免费的\n免费的\n重要的事情说三遍",
    		contentAlign: 'left',
    		checkBox: {
    			title: '不再提示',
    			isSelected: true
    		},
    		buttons: [{
    			title: '取消'
    		}, {
    			title: '否'
    		}, {
    			title: '确认',
    			titleColor: '#3F51B5'
    		}]
    	}, result => {
    		console.log(result)
    	});
[ (opens new window)](https://uniapp.dcloud.net.cn/plugin/native-

plugin.html#%E7%AC%AC%E5%9B%9B%E6%AD%A5-%E6%89%93%E5%8C%85%E5%8F%91%E5%B8%83-2)第四步:打包发布

使用自定义基座开发调试uni-app原生插件后,不可直接将自定义基座apk作为正式版发布。 应该重新提交云端打包(不能勾选“自定义基座”)生成正式版本。

注意事项

1.可以在 插件市场 查看更多插件,如需开发uni原生插件请参考 uni原生插件开发文档 (opens new window)。 2.如果插件需要传递文件路径,则需要传手机文件的绝对路径,可使用 5+ IO模块 (opens new window) 的相关 API 得到文件的绝对路径

4 JS语法

uni-app的js API由标准ECMAScript的js API 和 uni 扩展 API 这两部分组成。

标准ECMAScript的js仅是最基础的js。浏览器基于它扩展了window、document、navigator等对象。小程序也基于标准js扩展了各种wx.xx、my.xx、swan.xx的API。node也扩展了fs等模块。

uni-app基于ECMAScript扩展了uni对象,并且API命名与小程序保持兼容

标准js和浏览器js的区别

uni- app的js代码,h5端运行于浏览器中。非h5端(包含小程序和App),Android平台运行在v8引擎中,iOS平台运行在iOS自带的jscore引擎中,都没有运行在浏览器或webview里。

非H5端,虽然不支持window、document、navigator等浏览器的js API,但也支持标准ECMAScript。

请注意不要把浏览器里的js扩展对象等价于标准js。

所以uni- app的非H5端,一样支持标准js,支持if、for等语法,支持字符串、数字、时间、布尔值、数组、自定义对象等变量类型及各种处理方法。仅仅是不支持window、document、navigator等浏览器专用对象

ES6 支持

uni-app 在支持绝大部分 ES6 API 的同时,也支持了 ES7 的 await/async。

ES6 API 的支持,详见如下表格部分(x 表示不支持,无特殊说明则表示支持):

  • 因为iOS上不允许三方js引擎,所以iOS上不区分App、小程序、H5,各端均仅依赖iOS版本。
  • 各端Android版本有差异:
StringiOS8iOS9iOS10Android
codePointAt
normalizexx仅支持 NFD/NFC
includes
startsWith
endsWith
repeat
String.fromCodePoint
ArrayiOS8iOS9iOS10Android
---------------
copyWithin
find
findIndex
fill
entries
keys
valuesxx
includesx
Array.from
Array.of
NumberiOS8iOS9iOS10Android
---------------
isFinite
isNaN
parseInt
parseFloat
isInteger
EPSILON
isSafeInteger
MathiOS8iOS9iOS10Android
---------------
trunc
sign
cbrt
clz32
imul
fround
hypot
expm1
log1p
log10
log2
sinh
cosh
tanh
asinh
acosh
atanh
ObjectiOS8iOS9iOS10Android
---------------
is
assign
getOwnPropertyDescriptor
keys
getOwnPropertyNames
getOwnPropertySymbols
OtheriOS8iOS9iOS10Android<5
---------------
Symbol
Set
Map
Proxyxxx
Reflect
Promise

注意

  • App端Android支持不依赖Android版本号,即便是Android4.4也是上表数据。因为uni-app的js代码运行在自带的独立jscore中,没有js的浏览器兼容性问题。uni-app的vue页面在Android低端机上只有css浏览器兼容性问题,因为vue页面仍然渲染在webview中,受Android版本影响,太新的css语法在低版本不支持。
  • 默认不需要在微信工具里继续开启es6转换。但如果用了微信的wxml自定义组件(wxcomponents目录下),uni-app编译器并不会处理这些文件中的es6代码,需要去微信工具里开启转换。从HBuilderX调起微信工具时,如果发现工程下有wxcomponents目录会自动配置微信工程打开es6转换。

5 CSS语法

uni-app 的 css 与 web 的 css 基本一致。本文没有讲解 css 的用法。在你了解 web 的 css 的基础之上,本文讲述一些样式相关的注意事项。

uni-app 有 vue 页面和 nvue 页面。vue 页面是 webview 渲染的、app 端的 nvue 页面是原生渲染的。在 nvue 页面里样式比 web 会限制更多,另见nvue 样式专项文档 (opens new window)

尺寸单位

uni-app 支持的通用 css 单位包括 px、rpx

  • px 即屏幕像素
  • rpx 即响应式 px,一种根据屏幕宽度自适应的动态单位。以 750 宽的屏幕为基准,750rpx 恰好为屏幕宽度。屏幕变宽,rpx 实际显示效果会等比放大,但在 App(vue2 不含 nvue) 端和 H5(vue2) 端屏幕宽度达到 960px 时,默认将按照 375px 的屏幕宽度进行计算,具体配置参考:rpx 计算配置 (opens new window)

vue 页面支持下面这些普通 H5 单位,但在 nvue 里不支持:

  • rem 根字体大小可以通过 page-meta (opens new window) 配置
  • vh viewpoint height,视窗高度,1vh 等于视窗高度的 1%
  • vw viewpoint width,视窗宽度,1vw 等于视窗宽度的 1%

nvue 还不支持百分比单位。

App 端,在 pages.json 里的 titleNView 或页面里写的 plus api 中涉及的单位,只支持 px。注意此时不支持 rpx

nvue 中,uni-app 模式(nvue 不同编译模式介绍 (opens new window))可以使用 px 、rpx,表现与 vue 中基本一致,另外启用 dynamicRpx (opens new window) 后可以适配屏幕大小动态变化。weex 模式目前遵循 weex 的单位,它的单位比较特殊:

  • px:,以 750 宽的屏幕为基准动态计算的长度单位,与 vue 页面中的 rpx 理念相同。(一定要注意 weex 模式的 px,和 vue 里的 px 逻辑不一样。)
  • wx:与设备屏幕宽度无关的长度单位,与 vue 页面中的 px 理念相同

下面对 rpx 详细说明:

设计师在提供设计图时,一般只提供一个分辨率的图。

严格按设计图标注的 px 做开发,在不同宽度的手机上界面很容易变形。

而且主要是宽度变形。高度一般因为有滚动条,不容易出问题。由此,引发了较强的动态宽度单位需求。

微信小程序设计了 rpx 解决这个问题。uni-app 在 App 端、H5 端都支持了 rpx,并且可以配置不同屏幕宽度的计算方式,具体参考:rpx 计算配置 (opens new window)

rpx 是相对于基准宽度的单位,可以根据屏幕宽度进行自适应。uni-app 规定屏幕基准宽度 750rpx。

开发者可以通过设计稿基准宽度计算页面元素 rpx 值,设计稿 1px 与框架样式 1rpx 转换公式如下:

    设计稿 1px / 设计稿基准宽度 = 框架样式 1rpx / 750rpx

换言之,页面元素宽度在 uni-app 中的宽度计算公式:

    750 * 元素在设计稿中的宽度 / 设计稿基准宽度

举例说明:

  1. 若设计稿宽度为 750px,元素 A 在设计稿上的宽度为 100px,那么元素 A 在 uni-app 里面的宽度应该设为:750 * 100 / 750,结果为:100rpx。
  2. 若设计稿宽度为 640px,元素 A 在设计稿上的宽度为 100px,那么元素 A 在 uni-app 里面的宽度应该设为:750 * 100 / 640,结果为:117rpx。
  3. 若设计稿宽度为 375px,元素 B 在设计稿上的宽度为 200px,那么元素 B 在 uni-app 里面的宽度应该设为:750 * 200 / 375,结果为:400rpx。

Tips

  • 注意 rpx 是和宽度相关的单位,屏幕越宽,该值实际像素越大。如不想根据屏幕宽度缩放,则应该使用 px 单位。
  • 如果开发者在字体或高度中也使用了 rpx ,那么需注意这样的写法意味着随着屏幕变宽,字体会变大、高度会变大。如果你需要固定高度,则应该使用 px 。
  • rpx 不支持动态横竖屏切换计算,使用 rpx 建议锁定屏幕方向
  • 设计师可以用 iPhone6 作为视觉稿的标准。
  • 如果设计稿不是 750px,HBuilderX 提供了自动换算的工具,详见:HBuilderX中自动转换px为upx (opens new window)
  • App 端,在 pages.json 里的 titleNView 或页面里写的 plus api 中涉及的单位,只支持 px,不支持 rpx。
  • 早期 uni-app 提供了 upx ,目前已经推荐统一改为 rpx 了,详见 (opens new window)

选择器

目前支持的选择器有:

选择器样例样例描述
.class.intro选择所有拥有 class="intro" 的组件
#id#firstname选择拥有 id="firstname" 的组件
elementview选择所有 view 组件
element, elementview, checkbox选择所有文档的 view 组件和所有的 checkbox 组件
::afterview::after在 view 组件后边插入内容,仅 vue 页面生效
::beforeview::before在 view 组件前边插入内容,仅 vue 页面生效

注意:

  • uni-app 中不能使用 * 选择器。

  • 微信小程序自定义组件中仅支持 class 选择器

  • page 相当于 body 节点,例如:

        <!-- 设置页面背景颜色,使用 scoped 会导致失效 -- > 
      page {
    	background-color: #ccc;
    }

全局样式与局部样式

定义在 App.vue 中的样式为全局样式,作用于每一个页面。在 pages 目录下 的 vue 文件中定义的样式为局部样式,只作用在对应的页面,并会覆盖 App.vue 中相同的选择器。

注意:

  • App.vue 中通过 @import 语句可以导入外联样式,一样作用于每一个页面。
  • nvue 页面暂不支持全局样式

CSS 变量

uni-app 提供内置 CSS 变量

CSS 变量描述App小程序H5
--status-bar-height系统状态栏高度系统状态栏高度 (opens new window)、nvue 注意见下25px0
--window-top内容区域距离顶部的距离00NavigationBar 的高度
--window-bottom内容区域距离底部的距离00TabBar 的高度

注意:

  • var(--status-bar-height) 此变量在微信小程序环境为固定 25px,在 App 里为手机实际状态栏高度。
  • 当设置 "navigationStyle":"custom" 取消原生导航栏后,由于窗体为沉浸式,占据了状态栏位置。此时可以使用一个高度为 var(--status-bar-height) 的 view 放在页面顶部,避免页面内容出现在状态栏。
  • 由于在 H5 端,不存在原生导航栏和 tabbar,也是前端 div 模拟。如果设置了一个固定位置的居底 view,在小程序和 App 端是在 tabbar 上方,但在 H5 端会与 tabbar 重叠。此时可使用--window-bottom,不管在哪个端,都是固定在 tabbar 上方。
  • 目前 nvue 在 App 端,还不支持 --status-bar-height变量,替代方案是在页面 onLoad 时通过 uni.getSystemInfoSync().statusBarHeight 获取状态栏高度,然后通过 style 绑定方式给占位 view 设定高度

代码块

快速书写 css 变量的方法是:在 css 中敲 hei,在候选助手中即可看到 3 个 css 变量。(HBuilderX 1.9.6 以上支持)

示例 1 - 普通页面使用 css 变量

    <template>
    	<!-- HBuilderX 2.6.3+ 新增 page-meta, 详情:https://uniapp.dcloud.io/component/page-meta -->
    	<page-meta>
    		<navigation-bar />
    	</page-meta>
    	<view>
    		<view class="status_bar">
    			<!-- 这里是状态栏 -->
    		</view>
    		<view>状态栏下的文字</view>
    	</view>
    </template>
    <style>
    	.status_bar {
    		height: var(--status-bar-height);
    		width: 100%;
    	}
    </style>
    <template>
    	<view>
    		<view class="toTop">
    			<!-- 这里可以放一个向上箭头,它距离底部tabbar上浮10px-->
    		</view>
    	</view>
    </template>
    <style>
    	.toTop {
    		bottom: calc(var(--window-bottom) + 10px);
    	}
    </style>

示例 2 - nvue 页面获取状态栏高度

    <template>
    	<view class="content">
    		<view :style="{ height: iStatusBarHeight + 'px'}"></view>
    	</view>
    </template>
    
    <script>
    	export default {
    		data() {
    			return {
    				iStatusBarHeight: 0,
    			};
    		},
    		onLoad() {
    			this.iStatusBarHeight = uni.getSystemInfoSync().statusBarHeight;
    		},
    	};
    </script>

固定值

uni-app 中以下组件的高度是固定的,不可修改:

组件描述AppH5
NavigationBar导航栏44px44px
TabBar底部选项卡HBuilderX 2.3.4 之前为 56px,2.3.4 起和 H5 调为一致,统一为 50px。(但可以自主更改高度)50px

各小程序平台,包括同小程序平台的 iOS 和 Android 的高度也不一样

Flex 布局

为支持跨平台,框架建议使用 Flex 布局

背景图片

uni-app 支持使用在 css 里设置背景图片,使用方式与普通 web 项目大体相同,但需要注意以下几点:

  • 支持 base64 格式图片。

  • 支持网络路径图片。

  • 小程序不支持在 css 中使用本地文件,包括本地的背景图和字体文件。需以 base64 方式方可使用。

  • 使用本地路径背景图片需注意:

    1. 为方便开发者,在背景图片小于 40kb 时,uni-app 编译到不支持本地背景图的平台时,会自动将其转化为 base64 格式;
    2. 图片大于等于 40kb,会有性能问题,不建议使用太大的背景图,如开发者必须使用,则需自己将其转换为 base64 格式使用,或将其挪到服务器上,从网络地址引用。
    3. 本地背景图片的引用路径推荐使用以 ~@ 开头的绝对路径。
        .test2 {
    	background-image: url('~@/static/logo.png');
    }

注意

  • 微信小程序不支持相对路径(真机不支持,开发工具支持)

字体图标

uni-app 支持使用字体图标,使用方式与普通 web 项目相同,需要注意以下几点:

  • 支持 base64 格式字体图标。

  • 支持网络路径字体图标。

  • 小程序不支持在 css 中使用本地文件,包括本地的背景图和字体文件。需以 base64 方式方可使用。

  • 网络路径必须加协议头 https

  • http://www.iconfont.cn (opens new window) 上拷贝的代码,默认是没加协议头的。

  • http://www.iconfont.cn (opens new window) 上下载的字体文件,都是同名字体(字体名都叫 iconfont,安装字体文件时可以看到),在 nvue 内使用时需要注意,此字体名重复可能会显示不正常,可以使用工具修改。

  • 使用本地路径图标字体需注意:

    1. 为方便开发者,在字体文件小于 40kb 时,uni-app 会自动将其转化为 base64 格式;
    2. 字体文件大于等于 40kb,仍转换为 base64 方式使用的话可能有性能问题,如开发者必须使用,则需自己将其转换为 base64 格式使用,或将其挪到服务器上,从网络地址引用;
    3. 字体文件的引用路径推荐使用以 ~@ 开头的绝对路径。
        @font-face {
    	font-family: test1-icon;
    	src: url('~@/static/iconfont.ttf');
    }

nvue中不可直接使用 css 的方式引入字体文件,需要使用以下方式在 js 内引入。nvue 内不支持本地路径引入字体,请使用网络链接或者base64形式。src字段的url的括号内一定要使用单引号。

    var domModule = weex.requireModule('dom');
    domModule.addRule('fontFace', {
    	fontFamily: 'fontFamilyName',
    	src: "url('https://...')",
    });

示例:

    <template>
    	<view>
    		<view>
    			<text class="test">&#xe600;</text>
    			<text class="test">&#xe687;</text>
    			<text class="test">&#xe60b;</text>
    		</view>
    	</view>
    </template>
    <style>
    	@font-face {
    		font-family: 'iconfont';
    		src: url('https://at.alicdn.com/t/font_865816_17gjspmmrkti.ttf') format('truetype');
    	}
    	.test {
    		font-family: iconfont;
    		margin-left: 20rpx;
    	}
    </style>

6 uniapp中使用Vue2语法注意

基础

在 uni-app 中使用vue的差异

uni-app 在发布到H5时支持所有vue的语法;发布到App和小程序时,由于平台限制,无法实现全部vue语法,但 uni-app 仍是对vue语法支持度最高的跨端框架。

相比Web平台, Vue.js 在 uni-app 中使用差异主要集中在两个方面:

uni-app 项目对 vue 3.0 的支持版本情况如下:

  • Web平台:支持。
  • 小程序平台:HBuilderX 3.3.3+ 编译器改为 vite,之前版本的编译器为webpack
  • App 平台:uni-app 3.2.5+支持。HBuilderX 3.3.13nvue编译器升级为vite

注意事项

  • vue3 响应式基于 Proxy 实现,不支持iOS9ie11
  • 暂不支持新增的 Teleport,Suspense 组件。
  • 目前 HBuilderX 3.2 起已预置,之前的版本只能使用cli方式

v-show

v-show 是一个根据条件展示元素选项的指令 。用法大致和 v-if 一样:

    	<view v-show="ok">Hello!</view>

不同的是带有 v-show 的元素始终会被渲染并保留在 DOM 中。v-show 只是简单地切换元素的 CSS 属性的 display

注意,v-show 不支持 template 元素,也不支持 v-else。nvue 页面不支持 v-show

v-for

  • 在H5平台 使用 v-for 循环整数时和其他平台存在差异,如 v-for="(item, index) in 10" 中,在H5平台 item 从 1 开始,其他平台 item 从 0 开始,可使用第二个参数 index 来保持一致。
  • 在非H5平台 循环对象时不支持第三个参数,如 v-for="(value, name, index) in object" 中,index 参数是不支持的

v-html

更新元素的 innerHTML

  • 注意:内容按普通 HTML 插入 - 不会作为 Vue 模板进行编译。
  • 如果试图使用 v-html 组合模板,可以重新考虑是否通过使用组件来替代。
  • App端和H5端支持 v-html ,微信小程序会被转为 rich-text,其他端不支持 v-html

跨端的富文本处理方案详见:https://ask.dcloud.net.cn/article/35772

    	<template>
    		<view>
    			<view v-html="rawHtml"></view>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					rawHtml: '<div style="text-align:center;background-color: #007AFF;"><div >我是内容</div><img src="https://web-assets.dcloud.net.cn/unidoc/zh/uni@2x.png"/></div>'
    				}
    			}
    		}
    	</script>

Class 与 Style 绑定

小程序端不支持 classObjectstyleObject 语法。

    	<template>
    		<view>
    			<view :class="activeClass">hello uni-app</view>
    			<view :style="styleObject">hello uni-app</view>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					activeClass: {
    						'active': true,
    						'text-danger': false
    					},
    					styleObject: {
    						color: 'red',
    						fontSize: '20px'
    					}
    				}
    			}
    		}
    	</script>
    	<style>
    		.active {
    			background-color: #007AFF;
    		}
    		.text-danger {
    			font-size: 60rpx;
    			color: #DD524D;
    		}
    	</style>

事件修饰符

修饰符 (modifier) 是以半角句号 . 指明的特殊后缀,用于指出一个指令应该以特殊方式绑定。例如,.prevent 修饰符告诉 @事件对于触发的事件调用 event.preventDefault()

@事件(v-on)提供了事件修饰符:

  • .stop: 各平台均支持, 使用时会阻止事件冒泡,在非 H5 端同时也会阻止事件的默认行为
  • .native: 监听原生事件,各平台均支持
  • .prevent: 仅在 H5 平台支持
  • .capture: 仅在 H5 平台支持
  • .self: 仅在 H5 平台支持
  • .once: 仅在 H5 平台支持
  • .passive: 仅在 H5 平台支持
    	<!-- 阻止单击事件继续传播 -->
    	<view @click.stop="doThis"></view>

使用修饰符时,顺序很重要;相应的代码会以同样的顺序产生。因此,用 @click.prevent.self 会阻止所有的点击,而 @click.self.prevent 只会阻止对元素自身的点击。

注意

  • 为兼容各端,事件需使用 @ 的方式绑定,请勿使用小程序端的 bindcatch 进行事件绑定;也不能在 JS 中使用event.preventDefault()event.stopPropagation()方法;
  • 若需要禁止蒙版下的页面滚动,可使用 @touchmove.stop.prevent="moveHandle"moveHandle 可以用来处理 touchmove 的事件,也可以是一个空函数。
    <view class="mask" @touchmove.stop.prevent="moveHandle"></view>
  • 按键修饰符:uni-app 运行在手机端,没有键盘事件,所以不支持按键修饰符

表单控件绑定

你可以用 v-model 指令在表单 inputtextareaselect 元素上创建双向数据绑定。它会根据控件类型自动选取正确的方法来更新元素。尽管有些神奇,但 v-model 本质上不过是语法糖。它负责监听用户的输入事件以更新数据,并对一些极端场景进行一些特殊处理。

v-model 会忽略所有表单元素的 valuecheckedselected attribute 的初始值而总是将 Vue 实例的数据作为数据来源。你应该通过 JavaScript 在组件的 data 选项中声明初始值。

建议开发过程中直接使用 uni-app表单组件 (opens new window)

用法示例:

  • H5 的 select 标签用 picker 组件进行代替
    <template>
    		<view>
    			<picker @change="bindPickerChange" :value="index" :range="array">
    				<view class="picker">
    					当前选择:{{array[index]}}
    				</view>
    			</picker>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					index: 0,
    					array: ['A', 'B', 'C']
    				}
    			},
    			methods: {
    				bindPickerChange(e) {
    					console.log(e)
    				}
    			}
    		}
    	</script>
  • 表单元素 radioradio-group 组件进行代替
    	<template>
    		<view>
    			<radio-group class="radio-group" @change="radioChange">
    				<label class="radio" v-for="(item, index) in items" :key="item.name">
    					<radio :value="item.name" :checked="item.checked" /> {{item.value}}
    				</label>
    			</radio-group>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					items: [{
    							name: 'USA',
    							value: '美国'
    						},
    						{
    							name: 'CHN',
    							value: '中国',
    							checked: 'true'
    						},
    						{
    							name: 'BRA',
    							value: '巴西'
    						},
    						{
    							name: 'JPN',
    							value: '日本'
    						},
    						{
    							name: 'ENG',
    							value: '英国'
    						},
    						{
    							name: 'TUR',
    							value: '法国'
    						}
    					]
    				}
    			},
    			methods: {
    				radioChange(e) {
    					console.log('radio发生change事件,携带value值为:', e.target.value)
    				}
    			}
    		}
    	</script>

计算属性 vs 侦听属性

Vue 提供了一种更通用的方式来观察和响应 Vue 实例上的数据变动:侦听属性 。当你有一些数据需要随着其它数据变动而变动时,你很容易滥用 watch 。然而,通常更好的做法是使用计算属性而不是命令式的 watch 回调。

    	export default {
    		data() {
    			return {
    				firstName: 'Foo',
    				lastName: 'Bar',
    				fullName: 'Foo Bar'
    			}
    		},
    		watch: {
    			firstName: function(val) {
    				this.fullName = val + ' ' + this.lastName
    			},
    			lastName: function(val) {
    				this.fullName = this.firstName + ' ' + val
    			}
    		}
    	}

上面代码是命令式且重复的。将它与计算属性的版本进行比较:

    	export default {
    		data() {
    			return {
    				firstName: 'Foo',
    				lastName: 'Bar'
    			}
    		},
    		computed: {
    		    fullName(){
    				return this.firstName + ' ' + this.lastName
    		    }
    		}
    	}

侦听器watch侦听器watch

  • 类型:{ [key: string]: string | Function | Object | Array }
  • 一个对象,键是需要观察的表达式,值是对应回调函数。值也可以是方法名,或者包含选项的对象。Vue 实例将会在实例化时调用 $watch() ,遍历 watch 对象的每一个 property
  • 示例:
    <template>
    	<view>
    		<input type="text" v-model="word">
    	</view>
    </template>
    <script>
    	export default {
    		data() {
    			return {
    				word: 'word'
    			}
    		},
    		watch: {
    			// 使用watch来响应数据的变化
    			word(newVal, oldVal) {
    				console.log('最新值是:'+newVal,"原来的值是:"+ oldVal);
    			}
    		},
    	}
    </script>

示例:

    <script>
    	export default {
    		data() {
    			return {
    				a: 1,
    				b: 2,
    				c: 3,
    				d: 4,
    				e: {
    					f: {
    						g: 5
    					}
    				}
    			}
    		},
    		watch: {
    			a: function(val, oldVal) {
    				console.log('new: %s, old: %s', val, oldVal)
    			},
    			// 方法名
    			b: 'someMethod',
    			// 该回调会在任何被侦听的对象的 property 改变时被调用,不论其被嵌套多深
    			c: {
    				handler: function(val, oldVal) { /* ... */ },
    				deep: true
    			},
    			// 该回调将会在侦听开始之后被立即调用
    			d: {
    				handler: 'someMethod',
    				immediate: true
    			},
    			// 你可以传入回调数组,它们会被逐一调用
    			e: [
    				'handle1',
    				function handle2(val, oldVal) { /* ... */ },
    				{
    					handler: function handle3(val, oldVal) { /* ... */ },
    					/* ... */
    				}
    			],
    			// watch vm.e.f's value: {g: 5}
    			'e.f': function(val, oldVal) { /* ... */ }
    		}
    	}
    </script>

组件

基础组件是内置在uni-app框架中的,包括view、text、input、button、video等几十个基础组件,列表详见:uni-app基础组件 (opens new window)

但仅有基础组件是不够用的,实际开发中会有很多封装的组件。

比如我们需要一个五角星点击评分的组件,在DCloud的插件市场里可以获取到:https://ext.dcloud.net.cn/plugin?id=33

把这个uni-rate组件导入到你的uni-app项目下,在需要的vue页面里引用它,就可以在指定的地方显示出这个五角星组件。

    	<!-- 在index.vue页面引用 uni-rate 组件-->
    	<template>
    		<view>
    			<uni-rate></uni-rate><!-- 这里会显示一个五角星,并且点击后会自动亮星 -->
    		</view>
    	</template>

注册

在注册一个组件的时候,我们始终需要给它一个名字。 定义组件名的方式有两种:

  • 使用 kebab-case

当使用 kebab-case (短横线分隔命名) 定义一个组件时,你也必须在引用这个自定义元素时使用 kebab-case,例如 <my- component-name>

  • 使用 PascalCase

当使用 PascalCase (首字母大写命名) 定义一个组件时,你在引用这个自定义元素时两种命名法都可以使用。 也就是说 <my-component- name><MyComponentName> 都是可接受的。

在uni-app工程根目录下的 components 目录,创建并存放自定义组件:

    │─components            	符合vue组件规范的uni-app组件目录
    │  └─componentA         	符合‘components/组件名称/组件名称.vue’目录结构,easycom方式可直接使用组件
    │  		└─componentA.vue    可复用的componentA组件
    │  └─component-a.vue      可复用的component-a组件

全局注册

uni-app 支持配置全局组件,需在 main.js 里进行全局注册,注册后就可在所有页面里使用该组件。

注意

  • Vue.component 的第一个参数必须是静态的字符串。
  • nvue 页面暂不支持全局组件。

main.js 里进行全局导入和注册

    	import Vue from 'vue'
    	import pageHead from './components/page-head.vue'
    	Vue.component('page-head',pageHead)

index.vue 里可直接使用组件

    	<template>
    		<view>
    			<page-head></page-head>
    		</view>
    	</template>

局部注册

局部注册之前,在需要引用该组件的页面,导入你想使用的组件。

页面引入组件方式

如下通过两种方式导入一个角标的组件库,详见 (opens new window),推荐使用 easycom 方式引入。

  1. 传统vue规范: 在 index.vue 页面中,通过 import 方式引入组件 ,在 components 选项中定义你想要使用的组件。
    	<!-- 在index.vue引入 uni-badge 组件-->
    	<template>
    		<view>
    			<uni-badge text="1"></uni-badge><!-- 3.使用组件 -->
    		</view>
    	</template>
    	<script>
    		import uniBadge from '@/components/uni-badge/uni-badge.vue';//1.导入组件(这步属于传统vue规范,但在uni-app的easycom下可以省略这步)
    		export default {
    			components:{uniBadge }//2.注册组件(这步属于传统vue规范,但在uni-app的easycom下可以省略这步) 
    		}
    	</script>

对于 components 对象中的每个 property 来说,其 property 名就是自定义元素的名字,其 property 值就是这个组件的选项对象。

在对象中放一个类似 uniBadge 的变量名其实是 uniBadge : uniBadge 的缩写,即这个变量名同时是:

  • 用在模板中的自定义元素的名称
  • 包含了这个组件选项的变量名(仅支持驼峰法命名)
  1. 通过uni-app的easycom (opens new window) 将组件引入精简为一步。只要组件安装在项目的 components 目录下,并符合 components/组件名称/组件名称.vue 目录结构。就可以不用引用、注册,直接在页面中使用。
    	<!-- 在index.vue引入 uni-badge 组件-->
    	<template>
    		<view>
    			<uni-badge text="1"></uni-badge><!-- 3.使用组件 -->
    		</view>
    	</template>
    	<script>
    		// 这里不用import引入,也不需要在components内注册uni-badge组件。template里就可以直接用
    		export default {
    			data() {
    				return {
    				}
    			}
    		}
    	</script>
  • easycom是自动开启的 ,不需要手动开启,有需求时可以在 pages.jsoneasycom 节点进行个性化设置,详见 (opens new window)
  • 不管components目录下安装了多少组件,easycom打包后会自动剔除没有使用的组件,对组件库的使用尤为友好。

组件是 vue 技术中非常重要的部分,组件使得与ui相关的轮子可以方便的制造和共享,进而使得 vue 使用者的开发效率大幅提升。

uni-app 搭建了组件的插件市场,有很多现成的组件,若下载符合components/组件名称/组件名称.vue目录结构的组件,均可直接使用。uni-app插件市场 (opens new window)

uni-app只支持 vue单文件组件(.vue 组件)。其他的诸如:动态组件,自定义 render ,和 <script type="text/x-template"> 字符串模版等,在非H5端不支持

ref

被用来给元素或子组件注册引用信息,引用信息将会注册在父组件的 $refs 对象上。

如果在普通的 DOM 元素上使用,引用指向的就是 DOM 元素;如果用在子组件上,引用就指向组件实例:

    <!-- 非H5端不支持通过this.$refs.content来获取view实例 -->
    <view ref="content">hello</view>
    
    <!-- 支持通过this.$refs.child来获取child-component实例 -->
    <child-component ref="child"></child-component>

refv-for 一起用于元素或组件的时候,引用信息将是包含 DOM 节点或组件实例的数组

小程序不支持列表

  • 作用域插槽(HBuilderX 3.1.19 以下仅支持解构插槽且不可使用作用域外数据以及使用复杂的表达式)
  • 动态组件
  • 异步组件
  • inline-template
  • X-Templates
  • keep-alive(App端也未支持)
  • transition (可使用 animation 或 CSS 动画替代)

命名限制

在 uni-app 中以下这些作为保留关键字,不可作为组件名。

  • a
  • canvas
  • cell
  • content
  • countdown
  • datepicker
  • div
  • element
  • embed
  • header
  • image
  • img
  • indicator
  • input
  • link
  • list
  • loading-indicator
  • loading
  • marquee
  • meta
  • refresh
  • richtext
  • script
  • scrollable
  • scroller
  • select
  • slider-neighbor
  • slider
  • slot
  • span
  • spinner
  • style
  • svg
  • switch
  • tabbar
  • tabheader
  • template
  • text
  • textarea
  • timepicker
  • transition-group
  • transition
  • video
  • view
  • web

Tips

  • 除以上列表中的名称外,标准的 HTML 及 SVG 标签名也不能作为组件名。
  • 在百度小程序中使用时,不要在 data 内使用 hidden ,可能会导致渲染错误。
  • methods中不可使用与生命周期同名的方法名

API

全局配置

Vue 全局配置描述H5App端小程序说明
Vue.config.silent取消 Vue 所有的日志与警告 详情 (opens new window)
Vue.config.optionMergeStrategies自定义合并策略的选项 详情 (opens new window)
Vue.config.devtools配置是否允许 vue-devtools 检查代码 详情 (opens new window)xx只在Web环境下支持
Vue.config.errorHandler指定组件的渲染和观察期间未捕获错误的处理函数 详情 (opens new window)
Vue.config.warnHandler为 Vue 的运行时警告赋予一个自定义处理函数 详情 (opens new window)
Vue.config.ignoredElements须使 Vue 忽略在 Vue 之外的自定义元素 详情 (opens new window)强烈不推荐,会覆盖uni-app框架配置的内置组件
Vue.config.keyCodes给 v-on 自定义键位别名 详情 (opens new window)xx
Vue.config.performance设置为 true 以在浏览器开发工具的性能/时间线面板中启用对组件初始化、编译、渲染和打补丁的性能追踪 详情 (opens new window)xx只在Web环境下支持
Vue.config.productionTip设置为 false 以阻止 vue 在启动时生成生产提示 详情 (opens new window)-

全局 API

Vue 全局 API描述H5App端小程序说明
Vue.extend使用基础 Vue 构造器,创建一个“子类” 详情 (opens new window)x不可作为组件使用
Vue.nextTick在下次 DOM 更新循环结束之后执行延迟回调 详情 (opens new window)xx
Vue.set向响应式对象中添加一个 property,并确保这个新 property 同样是响应式的,且触发视图更新 详情 (opens new window)
Vue.delete删除对象的 property。如果对象是响应式的,确保删除能触发更新视图 详情 (opens new window)
Vue.directive注册或获取全局指令 详情 (opens new window)x
Vue.filter注册或获取全局过滤器 详情 (opens new window)x
Vue.component注册或获取全局组件。注册还会自动使用给定的 id 设置组件的名称 详情 (opens new window)
Vue.use安装 Vue.js 插件 详情 (opens new window)
Vue.mixin全局注册一个混入,影响注册之后所有创建的每个 Vue 实例 详情 (opens new window)
Vue.version提供字符串形式的 Vue 安装版本号 详情 (opens new window)
Vue.compile将一个模板字符串编译成 render 函数。只在完整版时可用。详情 (opens new window)xxuni-app使用的vue是只包含运行时的版本

选项

Vue 选项描述H5App端小程序说明
dataVue 实例的数据对象 详情 (opens new window)
propsprops 可以是数组或对象,用于接收来自父组件的数据 详情 (opens new window)
propsData创建实例时传递 props。主要作用是方便测试 详情 (opens new window)
computed计算属性将被混入到 Vue 实例中 详情 (opens new window)
methodsmethods 将被混入到 Vue 实例中 详情 (opens new window)
watch一个对象,键是需要观察的表达式,值是对应回调函数 详情 (opens new window)
el提供一个在页面上已存在的 DOM 元素作为 Vue 实例的挂载目标 详情 (opens new window)xx
template一个字符串模板作为 Vue 实例的标识使用 详情 (opens new window)xxuni-app使用的vue是只包含运行时的版本
render字符串模板的代替方案,该渲染函数接收一个 createElement 方法作为第一个参数用来创建 VNode。详情 (opens new window)xx
renderError当 render 函数遭遇错误时,提供另外一种渲染输出,只在开发者环境下工作 详情 (opens new window)xx
directives包含 Vue 实例可用指令的哈希表 详情 (opens new window)x
filters包含 Vue 实例可用过滤器的哈希表 详情 (opens new window)
components包含 Vue 实例可用组件的哈希表 详情 (opens new window)
parent指定已创建的实例之父实例,在两者之间建立父子关系 详情 (opens new window)不推荐
mixins选项接收一个混入对象的数组 详情 (opens new window)
extends允许声明扩展另一个组件 详情 (opens new window)
provide/inject允许一个祖先组件向其所有子孙后代注入一个依赖,不论组件层次有多深,并在其上下游关系成立的时间里始终生效 详情 (opens new window)
name允许组件模板递归地调用自身 详情 (opens new window)
delimiters改变纯文本插入分隔符 详情 (opens new window)xx
functional使组件无状态 (没有 data) 和无实例 (没有 this 上下文) 详情 (opens new window)xx
model允许一个自定义组件在使用 v-model 时定制 prop 和 event 详情 (opens new window)x
inheritAttrsinheritAttrs属性默认值为true,表示允许组件的根节点继承$attrs包含的属性 详情 (opens new window)x
comments当设为 true 时,将会保留且渲染模板中的 HTML 注释 详情 (opens new window)xx-

生命周期

生命周期钩子描述H5App端小程序说明
beforeCreate在实例初始化之后被调用 详情 (opens new window)
created在实例创建完成后被立即调用 详情 (opens new window)
beforeMount在挂载开始之前被调用 详情 (opens new window)
mounted挂载到实例上去之后调用 详情 (opens new window) 注意:此处并不能确定子组件被全部挂载,如果需要子组件完全挂载之后在执行操作可以使用$nextTick 详情 (opens new window)
beforeUpdate数据更新时调用,发生在虚拟 DOM 打补丁之前 详情 (opens new window)
updated由于数据更改导致的虚拟 DOM 重新渲染和打补丁,在这之后会调用该钩子 详情 (opens new window)
activated被 keep-alive 缓存的组件激活时调用 详情 (opens new window)x
deactivated被 keep-alive 缓存的组件停用时调用 详情 (opens new window)x
beforeDestroy实例销毁之前调用。在这一步,实例仍然完全可用 详情 (opens new window)
destroyedVue 实例销毁后调用。调用后,Vue 实例指示的所有东西都会解绑定,所有的事件监听器会被移除,所有的子实例也会被销毁 详情 (opens new window)
errorCaptured当捕获一个来自子孙组件的错误时被调用 详情 (opens new window)-

实例属性

Vue 实例属性描述H5App端小程序说明
vm.$dataVue 实例观察的数据对象 详情 (opens new window)
vm.$props当前组件接收到的 props 对象 详情 (opens new window)
vm.$elVue 实例使用的根 DOM 元素 详情 (opens new window)xx
vm.$options用于当前 Vue 实例的初始化选项 详情 (opens new window)
vm.$parent父实例,如果当前实例有的话 详情 (opens new window)H5端 viewtext 等内置标签是以 Vue 组件方式实现,$parent 会获取这些到内置组件,导致的问题是 this.$parent 与其他平台不一致,解决方式是使用 this.$parent.$parent 获取或自定义组件根节点由 view 改为 div
vm.$root当前组件树的根 Vue 实例 详情 (opens new window)
vm.$children当前实例的直接子组件 详情 (opens new window)H5端 viewtext 等内置标签是以 Vue 组件方式实现,$children 会获取到这些内置组件,导致的问题是 this.$children 与其他平台不一致,解决方式是使用 this.$children.$children 获取或自定义组件根节点由 view 改为 div
vm.$slots用来访问被插槽分发的内容 详情 (opens new window)x
vm.$scopedSlots用来访问作用域插槽 详情 (opens new window)
vm.$refs一个对象,持有注册过 ref attribute 的所有 DOM 元素和组件实例详情 (opens new window)非H5端只能用于获取自定义组件,不能用于获取内置组件实例(如:view、text)
vm.$isServer当前 Vue 实例是否运行于服务器 详情 (opens new window)xApp端总是返回false
vm.$attrs包含了父作用域中不作为 prop 被识别 (且获取) 的 attribute 绑定 详情 (opens new window)x
vm.$listeners包含了父作用域中的 (不含 .native 修饰器的) v-on 事件监听器 详情 (opens new window)x

实例方法

实例方法描述H5App端小程序说明
vm.$watch()观察 Vue 实例上的一个表达式或者一个函数计算结果的变化 详情 (opens new window)
vm.$set()这是全局 Vue.set 的别名 详情 (opens new window)
vm.$delete()这是全局 Vue.delete 的别名 详情 (opens new window)
vm.$on()监听当前实例上的自定义事件 详情 (opens new window)
vm.$once()监听一个自定义事件,但是只触发一次 详情 (opens new window)
vm.$off()移除自定义事件监听器 详情 (opens new window)
vm.$emit()触发当前实例上的事件 详情 (opens new window)
vm.$mount()手动地挂载一个未挂载的实例 详情 (opens new window)xx
vm.$forceUpdate()迫使 Vue 实例重新渲染 详情 (opens new window)
vm.$nextTick()将回调延迟到下次 DOM 更新循环之后执行 详情 (opens new window)
vm.$destroy()完全销毁一个实例 详情 (opens new window)-

模板指令

Vue 指令描述H5App端小程序说明
v-text更新元素的 textContent 详情 (opens new window)
v-html更新元素的 innerHTML 详情 (opens new window)x微信小程序会被转成 rich-text
v-show根据表达式之真假值,切换元素的 display CSS属性 详情 (opens new window)
v-if根据表达式的值的 truthiness 来有条件地渲染元素 详情 (opens new window)
v-else为 v-if 或者 v-else-if 添加“else 块” 详情 (opens new window)
v-else-if表示 v-if 的“else if 块”。可以链式调用 详情 (opens new window)
v-for基于源数据多次渲染元素或模板块 详情 (opens new window)
v-on绑定事件监听器 详情 (opens new window)
v-bind动态地绑定一个或多个 attribute,或一个组件 prop 到表达式 详情 (opens new window)
v-model在表单控件或者组件上创建双向绑定 详情 (opens new window)
v-pre跳过这个元素和它的子元素的编译过程 详情 (opens new window)x
v-cloak这个指令保持在元素上直到关联实例结束编译 详情 (opens new window)xx
v-once只渲染元素和组件一次 详情 (opens new window)x-

特殊属性

特殊属性描述H5App端小程序说明
key主要用在 Vue 的虚拟 DOM 算法,在新旧 nodes 对比时辨识 VNodes 详情 (opens new window)
refref 被用来给元素或子组件注册引用信息 详情 (opens new window)非 H5 平台只能获取 vue 组件实例不能获取到内置组件实例
is用于动态组件且基于 DOM 内模板的限制来工作 详情 (opens new window)√ (需传入 String 类型)x-

内置组件

内置组件描述H5App端小程序说明
component渲染一个“元组件”为动态组件。依 is 的值,来决定哪个组件被渲染 详情 (opens new window)x
transition作为单个元素/组件的过渡效果 详情 (opens new window)xx
transition-group作为多个元素/组件的过渡效果 详情 (opens new window)xx
keep-alive包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们 详情 (opens new window)xx
slot作为组件模板之中的内容分发插槽 详情 (opens new window)-
template并不是一个组件,它仅仅是一个包装元素,不会在页面中做任何渲染,只接受控制属性 详情 (opens new window)-

uni-app 全局变量的几种实现方式

挂载 Vue.prototype

将一些使用频率较高的常量或者方法,直接扩展到 Vue.prototype 上,每个 Vue 对象都会“继承”下来。

注意这种方式只支持vue页面

示例如下: 在 main.js 中挂载属性/方法

    Vue.prototype.websiteUrl = 'http://uniapp.dcloud.io';  
    Vue.prototype.now = Date.now || function () {  
        return new Date().getTime();  
    };  
    Vue.prototype.isArray = Array.isArray || function (obj) {  
        return obj instanceof Array;  
    };

然后在 pages/index/index.vue 中调用

    <script>  
        export default {  
            data() {  
                return {};  
            },  
            onLoad(){  
                console.log('now:' + this.now());  
            },  
            methods: {  
            }  
        }  
    </script>

这种方式,只需要在 main.js 中定义好即可在每个页面中直接调用。

globalData

小程序中有个globalData概念,可以在 App 上声明全局变量。 Vue 之前是没有这类概念的,但 uni-app 引入了globalData概念,并且在包括H5、App等平台都实现了。 在 App.vue 可以定义 globalData ,也可以使用 API 读写这个值。

globalData支持vue和nvue共享数据。

globalData是一种比较简单的全局变量使用方式。

定义:App.vue

    <script>  
        export default {  
            globalData: {  
                text: 'text'  
            },  
            onLaunch: function() {  
                console.log('App Launch')  
            },  
            onShow: function() {  
                console.log('App Show')  
            },  
            onHide: function() {  
                console.log('App Hide')  
            }  
        }  
    </script>  
    
    <style>  
        /*每个页面公共css */  
    </style>  

js中操作globalData的方式如下:

赋值:getApp().globalData.text = 'test'

取值:console.log(getApp().globalData.text) // 'test'

如果需要把globalData的数据绑定到页面上,可在页面的onshow声明周期里进行变量重赋值。HBuilderX 2.0.3起,nvue页面在uni- app编译模式下,也支持onshow。

Vuex

Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。

HBuilderX 2.2.5+起,支持vue和nvue之间共享。[参考 (opens new window)](https://uniapp.dcloud.io/use- weex?id=vue-%E5%92%8C-nvue-%E5%85%B1%E4%BA%AB%E7%9A%84%E5%8F%98%E9%87%8F%E5%92%8C%E6%95%B0%E6%8D%AE)

这里以登录后同步更新用户信息为例,简单说明下 Vuex 的用法,更多更详细的 Vuex 的内容,建议前往其官网 Vuex (opens new window) 学习下。

举例说明:

在 uni-app 项目根目录下新建 store 目录,在 store 目录下创建 index.js 定义状态值

    const store = new Vuex.Store({  
        state: {  
            login: false,  
            token: '',  
            avatarUrl: '',  
            userName: ''  
        },  
        mutations: {  
            login(state, provider) {  
                console.log(state)  
                console.log(provider)  
                state.login = true;  
                state.token = provider.token;  
                state.userName = provider.userName;  
                state.avatarUrl = provider.avatarUrl;  
            },  
            logout(state) {  
                state.login = false;  
                state.token = '';  
                state.userName = '';  
                state.avatarUrl = '';  
            }  
        }  
    })

然后,需要在 main.js 挂载 Vuex

    import store from './store'  
    Vue.prototype.$store = store

最后,在 pages/index/index.vue 使用

    <script>  
        import {  
            mapState,  
            mapMutations  
        } from 'vuex';  
    
        export default {  
            computed: {  
                ...mapState(['avatarUrl', 'login', 'userName'])  
            },  
            methods: {  
                ...mapMutations(['logout'])  
            }  
        }  
    </script>

.vue 和 .nvue 并不是一个规范,因此一些在 .vue 中适用的方案并不适用于 .nvue。 Vue 上挂载属性,不能在 .nvue 中使用

其他配置

Vue 组件编译到小程序平台的时候会编译为对应平台的组件,部分小程序平台支持 options 选项(具体选项参考对应小程序平台文档的自定义组件部分),一般情况默认即可,如有特殊需求可在 Vue 组件中增加 options 属性。

    export default {
      props: ['data'],
      data(){ return { } },
      options: {
        // 微信小程序中 options 选项
        multipleSlots: true, //  在组件定义时的选项中启动多slot支持,默认启用
        styleIsolation: "isolated",  //  启动样式隔离。当使用页面自定义组件,希望父组件影响子组件样式时可能需要配置。具体配置选项参见:微信小程序自定义组件的样式
        addGlobalClass: true, //  表示页面样式将影响到自定义组件,但自定义组件中指定的样式不会影响页面。这个选项等价于设置 styleIsolation: apply-shared
        virtualHost: true,  //  将自定义节点设置成虚拟的,更加接近Vue组件的表现。我们不希望自定义组件的这个节点本身可以设置样式、响应 flex 布局等,而是希望自定义组件内部的第一层节点能够响应 flex 布局或者样式由自定义组件本身完全决定
      }
    }

常见问题

如何获取上个页面传递的数据

在 onLoad 里得到,onLoad 的参数是其他页面打开当前页面所传递的数据

如何设置全局的数据和全局的方法

uni-app 内置了 Vuex (opens new window) ,在app里的使用,可参考 hello-uniapp store/index.js

    	//store.js
    	import Vue from 'vue'
    	import Vuex from 'vuex'
    	Vue.use(Vuex)
    	const store = new Vuex.Store({
    		state: {...},
    		mutations: {...},
    		actions: {...}
    	})
    
    	export default store
    
    	//main.js
    	...
    	import store from './store'
    	Vue.prototype.$store = store
    	const app = new Vue({
    		store,...
    	})
    	...
    
    	//test.vue 使用时:
    	import {mapState,mapMutations} from 'vuex'
如何捕获 app 的 onError

由于 onError 并不是完整意义的生命周期,所以只提供一个捕获错误的方法,在 app 的根组件上添加名为 onError 的回调函数即可。如下

    export default {
    	   // 只有 app 才会有 onLaunch 的生命周期
    		onLaunch () {
    		   // ...
    		},
    
    		// 捕获 app error
    		onError (err) {
    		   console.log(err)
    		}
    	}

组件属性设置不生效解决办法

当重复设置某些属性为相同的值时,不会同步到view层。 例如:每次将scroll-view组件的scroll- top属性值设置为0,只有第一次能顺利返回顶部。 这和props的单向数据流特性有关,组件内部scroll- top的实际值改动后,其绑定的属性并不会一同变化。

解决办法有两种(以scroll-view组件为例):

  1. 监听scroll事件,记录组件内部变化的值,在设置新值之前先设置为记录的当前值
    <scroll-view scroll-y="true" :scroll-top="scrollTop" @scroll="scroll"></scroll-view>
    export default {
        data() {
            return {
                scrollTop: 0,
                old: {
                    scrollTop: 0
                }
            }
        },
        methods: {
            scroll: function(e) {
                this.old.scrollTop = e.detail.scrollTop
            },
            goTop: function(e) {
                this.scrollTop = this.old.scrollTop
                this.$nextTick(function() {
                    this.scrollTop = 0
                });
            }
        }
    }
  1. 监听scroll事件,获取组件内部变化的值,实时更新其绑定值
    	<scroll-view scroll-y="true" :scroll-top="scrollTop" @scroll="scroll"></scroll-view>
    	export default {
    		data() {
    			return {
    				scrollTop: 0,
    			}
    		},
    		methods: {
    			scroll: function(e) {
    				// 如果使用此方法,请自行增加防抖处理
    				this.scrollTop = e.detail.scrollTop
    			},
    			goTop: function(e) {
    				this.scrollTop = 0
    			}
    		}
    	}

第二种解决方式在某些组件可能造成抖动,推荐第一种解决方式

组合式 API

目前 uni-app(Vue2) 基于 Vue 2.6,组合式 API 由 @vue/composition-api (opens new window) 支持,script setup 由 unplugin-vue2-script-setup (opens new window) 支持

升级 uni-app 编译器到 3.6.8+

  • HBuilderX 创建的项目直接升级 HBuilderX 到最新版即可
  • CLI 创建的项目参考 https://uniapp.dcloud.net.cn/quickstart-cli.html#cliversion 升级依赖到最新版
  1. 在 main.js/ts 文件内增加安装 @vue/composition-api 插件。如果使用 nvue 页面,也需要在每个 nvue 页面安装,且每个 nvue 页面之间插件状态默认不会共享。
    import Vue from 'vue'
    import App from './App.vue'
    
    Vue.config.productionTip = false
    
    import VueCompositionAPI from '@vue/composition-api'
    
    Vue.use(VueCompositionAPI)
    
    const app = new (typeof App === 'function' ? App : Vue.extend(Object.assign({ mpType: 'app' }, App)))
    app.$mount()
    // pages/index.vue
    import { defineComponent } from '@vue/composition-api'
    import { onReady } from '@dcloudio/uni-app'
    export default defineComponent({
      setup() {
        onReady(() => {
          console.log('onReady')
        })
      }
    }
  1. 从 @vue/composition-api 包内导入并使用基础的组合式API,具体的兼容性仍需参考:@vue/composition-api (opens new window)。从 @dcloudio/uni-app 包内导入 uni-app 其他生命周期API。
    import { defineComponent, ref } from '@vue/composition-api'
    import { onReady } from '@dcloudio/uni-app'
    export default defineComponent({
      setup() {
        const title = ref('Hello')
        onReady(() => {
          console.log('onReady')
        })
        return {
          title
        }
      }
    })
使用 Script Setup
  1. 使用 npm/yarn 安装 unplugin-vue2-script-setup 插件,此插件暂不支持 nvue 页面。
    npm install unplugin-vue2-script-setup -D
    # or
    yarn add unplugin-vue2-script-setup -D
  1. 在 vue.config.js 配置 ScriptSetup 插件,以下为基础配置,其他具体配置请参考 unplugin-vue2-script-setup (opens new window)
    const ScriptSetup = require('unplugin-vue2-script-setup/webpack').default
    module.exports = {
      parallel: false,
      configureWebpack: {
        plugins: [
          ScriptSetup({ /* options */ }),
        ],
      },
      chainWebpack (config) {
        // disable type check and let `vue-tsc` handles it
        config.plugins.delete('fork-ts-checker')
      },
    }
  1. 改用 Script Setup 写法导入 API
    <script setup lang="ts">
    import { ref } from '@vue/composition-api'
    import { onReady } from '@dcloudio/uni-app'
    const title = ref('Hello')
    onReady(() => {
      console.log('onReady')
    })
    </script>

7 uniapp中使用Vue3语法注意

基础

uni-app 项目对 vue 3.0 的支持版本情况如下

  • Web平台:支持。
  • 小程序平台:HBuilderX 3.3.3+ 编译器改为 vite,之前版本的编译器为webpack
  • App 平台:uni-app 3.2.5+支持。HBuilderX 3.3.13nvue编译器升级为vite

注意事项

  • vue3 响应式基于 Proxy 实现,不支持iOS9ie11
  • 暂不支持新增的 Teleport,Suspense 组件。
  • 目前 HBuilderX 3.2 起已预置,之前的版本只能使用cli方式

组件

定义自定义事件

可以通过 emits 选项在组件上定义已发出的事件。

    	// 在组件内
    	export default {
    		emits: ['in-focus', 'submit']
    	}

当在 emits 选项中定义了原生事件 (如 click) 时,将使用组件中的事件替代原生事件侦听器。

建议定义所有发出的事件,以便更好地记录组件应该如何工作。

示例

    	<template>
    		<view>
    			<!-- 我是counter组件 -->
    			<view>counter的值是:{{count}}</view>
    			<button type="default" @click="add">+1</button>
    		</view>
    	</template>
    	<script>
    		export default {
    			//1.声明自定义事件:组件的自定义事件,必须事先声明在emits节点中
    			emits:['count-change'],
    			data() {
    				return {
    					count:0
    				};
    			},
    			methods:{
    				add(){
    					this.count++
    					//2.触发自定义事件:当点击+1按钮时,调用this.$emit()方法,触发自定义count-change事件
    					this.$emit('count-change')
    				}
    			}
    		}
    	</script>
    	<template>
    		<view>
    			<!-- 我是父组件 -->
    			<!-- 3、监听自定义事件:通过v-on的形式监听自定义事件 -->
    			<counter @count-change="getCount"></counter>
    		</view>
    	</template>
    	<script>
    		export default {
    			methods: {
    				getCount(){
    					console.log("触发了count-change自定义事件")
    				}
    			}
    		}
    	</script>

验证抛出的事件

prop 类型验证类似,如果使用对象语法而不是数组语法定义发出的事件,则可以验证它。

要添加验证,将为事件分配一个函数,该函数接收传递给 $emit 调用的参数,并返回一个布尔值以指示事件是否有效。

    	export default {
    		emits: {
    			// 没有验证
    			click: null,
    
    			// 验证submit 事件
    			submit: ({ email, password }) => {
    				if (email && password) {
    					return true
    				} else {
    					console.warn('Invalid submit event payload!')
    					return false
    				}
    			}
    		},
    		methods: {
    			submitForm() {
    				this.$emit('submit', { email, password })
    			}
    		}
    	}

v-model 参数

默认情况下,组件上的 v-model 使用 modelValue 作为 propupdate:modelValue 作为事件。我们可以通过向 v-model 传递参数来修改这些名称:

    	<my-component v-model:foo="bar"></my-component>

在本例中,子组件将需要一个 foo prop 并发出 update:foo 要同步的事件:

    	<template>
    		<view>
    			<input type="text" :value="foo" @input="$emit('update:foo', $event.target.value)" >
    		</view>
    	</template>
    	<script>
    		export default {
    			props: {
    			  foo: String
    			}
    		}
    	</script>
    	<my-component v-model:foo="bar"></my-component>

示例

    	<template>
    		<view>
    			<view>父组件-count的值是:{{count}}</view>
    			<button type="default" @click="count +=1">+1</button>
    			<counter v-model:number="count"></counter>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					count:0
    				}
    			}
    		}
    	</script>
    	<!-- 我是counter组件 -->
    	<template>
    		<view>
    			  <view>子组件-count的值是:{{number}}</view>
    			  <button type="default" @click="add">+1</button>
    		</view>
    	</template>
    	<script>
    		export default {
    			props:['number'],
    			emits:['update:number'],
    			methods:{
    				add(){
    					this.$emit('update:number',this.number +1)//子组件通过this.$emit()方法修改number值
    				}
    			}
    		}
    	</script>

多个 v-model 绑定

通过利用以特定 prop 和事件为目标的能力,正如我们之前在 v-model 参数中所学的那样,我们现在可以在单个组件实例上创建多个 v-model 绑定。

每个 v-model 将同步到不同的 prop,而不需要在组件中添加额外的选项:

    <template>
    		<view>
    			<!-- 父组件 -->
    			<user-name
    			  v-model:first-name="firstName"
    			  v-model:last-name="lastName"
    			></user-name>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					firstName:"",
    					lastName:""
    				}
    			}
    		}
    	</script>
    	<!-- 我是user-name子组件 -->
    	<template>
    		<view>
    			<input type="text" :value="firstName" @input="$emit('update:firstName', $event.target.value)">
    			<input type="text" :value="lastName" @input="$emit('update:lastName', $event.target.value)">
    		</view>
    	</template>
    	<script>
    		export default {
    			props: {
    				firstName: String,
    				lastName: String
    			}
    		}
    	</script>

处理 v-model 修饰符

让我们创建一个示例自定义修饰符 capitalize,它将 v-model 绑定提供的字符串的第一个字母大写。

添加到组件 v-model 的修饰符将通过 modelModifiers prop 提供给组件。在下面的示例中,我们创建了一个组件,其中包含默认为空对象的 modelModifiers prop。

请注意,当组件的 created 生命周期钩子触发时,modelModifiers prop 包含 capitalize,其值为 true——因为它被设置在 v-model 绑定 v-model.capitalize="bar"

    	<!-- 我是父组件 -->
    	<template>
    		<view>
    			<my-component v-model.capitalize="myText"></my-component>
    		</view>
    	</template>
    	<script>
    		export default {
    			data() {
    				return {
    					myText:""
    				}
    			}
    		}
    	</script>
    	<!-- 我是 my-component子组件-->
    	<template>
    		<view>
    			<input type="text" :value="modelValue" @input="emitValue" style="border: red solid 1px;">
    		</view>
    	</template>
    	<script>
    		export default {
    			props: {
    				modelValue: String,
    				modelModifiers: {
    					default: () => ({})
    				}
    			},
    			created() {
    				console.log(this.modelModifiers) // { capitalize: true }
    			},
    			methods: {
    				emitValue(e) {
    					let value = e.target.value
    					if (this.modelModifiers.capitalize) {
    						value = value.charAt(0).toUpperCase() + value.slice(1)
    					}
    					//charAt() 方法可返回指定位置的字符
    					//toUpperCase() 方法用于把字符串转换为大写
    					//slice() 方法可从已有的数组中返回选定的元素
    					console.log("value: ",value);
    					this.$emit('update:modelValue', value)
    				}
    			}
    		}
    	</script>

对于带参数的 v-model 绑定,生成的 prop 名称将为 arg + "Modifiers"

    	<my-component v-model:foo.capitalize="bar"></my-component>
    	<!-- 我是 my-component子组件-->
    	<template>
    		<view>
    			<input type="text"
    			  :value="foo"
    			  @input="$emit('update:foo', $event.target.value)">
    		</view>
    	</template>
    	<script>
    		export default {
    			props: ['foo', 'fooModifiers'],
    			created() {
    			  console.log(this.fooModifiers) // { capitalize: true }
    			}
    		}
    	</script>

插槽

具名插槽

有时我们需要多个插槽。例如对于一个带有如下模板的 base-layout 组件:

    	<!-- base-layout组件 -->
    	<view class="container">
    		<header>
    		<!-- 我们希望把页头放这里 -->
    		</header>
    		<main>
    		<!-- 我们希望把主要内容放这里 -->
    		</main>
    		<footer>
    		<!-- 我们希望把页脚放这里 -->
    		</footer>
    	</view>

对于这样的情况,slot 元素有一个特殊的 attribute:name。这个 attribute 可以用来定义额外的插槽:

    	<view class="container">
    		<header>
    			<slot name="header"></slot>
    		</header>
    		<main>
    			<slot></slot>
    		</main>
    		<footer>
    			<slot name="footer"></slot>
    		</footer>
    	</view>

一个不带nameslot 出口会带有隐含的名字“default”

在向具名插槽提供内容的时候,我们可以在一个 template 元素上使用 v-slot 指令,并以 v-slot 的参数的形式提供其名称:

    	<template>
    		<view>
    		<!-- 父组件使用子组件`<base-layout>`,节点上使用v-slot特性: -->
    			<base-layout>
    				<template v-slot:header>
    					<view>Here might be a page title</view>
    				</template>
    				<template v-slot:default>
    					<view>A paragraph for the main content.</view>
    					<view>And another one.</view>
    				</template>
    				<template v-slot:footer>
    					<view>Here's some contact info</view>
    				</template>
    			</base-layout>
    		</view>
    	</template>

现在 template 元素中的所有内容都将会被传入相应的插槽。

渲染的 HTML 将会是:

    	<div class="container">
    		<header>
    			<div>Here might be a page title</div>
    		</header>
    		<main>
    			<div>A paragraph for the main content.</div>
    			<div>And another one.</div>
    		</main>
    		<footer>
    			<div>Here's some contact info</div>
    		</footer>
    	</div>

注意,v-slot 只能添加在 template 上 (只有一种例外情况)

具名插槽的缩写

v-onv-bind 一样,v-slot 也有缩写,即把参数之前的所有内容 (v-slot:) 替换为字符 # 。例如 v-slot:header 可以被重写为 #header

    	<base-layout>
    		<template #header>
    			<view>Here might be a page title</view>
    		</template>
    
    		<template #default>
    			<view>A paragraph for the main content.</view>
    			<view>And another one.</view>
    		</template>
    
    		<template #footer>
    			<view>Here's some contact info</view>
    		</template>
    	</base-layout>

然而,和其它指令一样,该缩写只在其有参数的时候才可用。这意味着以下语法是无效的:

    	<!-- This will trigger a warning -->
    	<todo-list #="{ item }">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ item }}</view>
    	</todo-list>

如果你希望使用缩写的话,你必须始终以明确插槽名取而代之:

    	<todo-list #default="{ item }">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ item }}</view>
    	</todo-list>
作用域插槽

有时让插槽内容能够访问子组件中才有的数据是很有用的。当一个组件被用来渲染一个项目数组时,这是一个常见的情况,我们希望能够自定义每个项目的渲染方式。

例如,我们有一个组件,包含 todo-items 的列表。

    <template>
    	<view>
    		<view v-for="(item, index) in items">
            {{ item }}
          </view>
    	</view>
    </template>
    <script>
    	export default {
    		data() {
    			return {
    				items: ['Feed a cat', 'Buy milk']
    			};
    		}
    	}
    </script>

我们可能需要替换插槽以在父组件上自定义它:

    	<todo-list>
    		<i class="fas fa-check">before--</i>
    		<view class="green">{{ item }}</view>
    	</todo-list>

但是,这是行不通的,因为只有 todo-list 组件可以访问 item,我们将从其父组件提供槽内容。

要使 item 可用于父级提供的 slot 内容,我们可以添加一个 slot 元素并将其绑定为属性:

    <template>
    	<view>
    		<view v-for="(item, index) in items">
    		   <slot :item="item"></slot>
    		</view>
    	</view>
    </template>
    <script>
    	export default {
    		data() {
    			return {
    				items: ['Feed a cat', 'Buy milk']
    			}
    		}
    	}
    </script>

绑定在 slot 元素上的 attribute 被称为插槽 prop 。现在在父级作用域中,我们可以使用带值的 v-slot 来定义我们提供的插槽 prop 的名字:

    <template>
    	<view>
    		<todo-list>
    			<template v-slot:default="slotProps">
    				<i class="fas fa-check"></i>
    				<view class="green">{{ slotProps.item }}</view>
    			</template>
    		</todo-list>
    	</view>
    </template>

在这个例子中,我们选择将包含所有插槽 prop 的对象命名为 slotProps,但你也可以使用任意你喜欢的名字。

独占默认插槽的缩写语法

在上述情况下,当被提供的内容只有默认插槽时,组件的标签才可以被当作插槽的模板来使用。这样我们就可以把 v-slot 直接用在组件上:

    	<todo-list v-slot:default="slotProps">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ slotProps.item }}</view>
    	</todo-list>

这种写法还可以更简单。就像假定未指明的内容对应默认插槽一样,不带参数的 v-slot 被假定对应默认插槽:

    	<todo-list v-slot="slotProps">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ slotProps.item }}</view>
    	</todo-list>

注意默认插槽的缩写语法不能和具名插槽混用 ,因为它会导致作用域不明确:

    <!-- 无效,会导致警告 -->
    	<todo-list v-slot="slotProps">
    		<todo-list v-slot:default="slotProps">
    			<i class="fas fa-check"></i>
    			<view class="green">{{ slotProps.item }}</view>
    		</todo-list>
    		<template v-slot:other="otherSlotProps">
    			slotProps is NOT available here
    		</template>
    	</todo-list>

只要出现多个插槽,请始终为所有的插槽使用完整的基于 template 的语法:

    	<todo-list>
    		<template v-slot:default="slotProps">
    			<i class="fas fa-check"></i>
    			<view class="green">{{ slotProps.item }}</view>
    		</template>
    
    		<template v-slot:other="otherSlotProps">
    			...
    		</template>
    	</todo-list>

解构插槽 Prop

作用域插槽的内部工作原理是将你的插槽内容包括在一个传入单个参数的函数里:

    function (slotProps) {
      // ... 插槽内容 ...
    }

这意味着 v-slot 的值实际上可以是任何能够作为函数定义中的参数的 JavaScript 表达式。你也可以使用 [ES2015 (opens new window)](https://developer.mozilla.org/zh- CN/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#Object_destructuring) 解构来传入具体的插槽 prop,如下:

    	<todo-list v-slot="{ item }">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ item }}</view>
    	</todo-list>

这样可以使模板更简洁,尤其是在该插槽提供了多个 prop 的时候。它同样开启了 prop 重命名等其它可能,例如将 item 重命名为 todo

    	<todo-list v-slot="{ item: todo }">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ todo }}</view>
    	</todo-list>

你甚至可以定义后备内容,用于插槽 propundefined 的情形:

    	<todo-list v-slot="{ item = 'Placeholder' }">
    		<i class="fas fa-check"></i>
    		<view class="green">{{ item }}</view>
    	</todo-list>

API

应用配置

config 是一个包含了 Vue 应用全局配置的对象。你可以在应用挂载前修改其以下 property

    const app = Vue.createApp({})
    
    app.config = {...}
```应用配置 | 描述 | H5 | App端 | 微信小程序 | 说明  
---|---|---|---|---|---  
errorHandler | 指定一个处理函数,来处理组件渲染方法执行期间以及侦听器抛出的未捕获错误。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#errorhandler) | √ | √ | √ |   
warnHandler | 为 `Vue` 的运行时警告指定一个自定义处理函数。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#warnhandler) | √ | √ | √ |   
globalProperties | 添加可以在应用程序内的任何组件实例中访问的全局 `property`。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#globalproperties) | √ | √ | √ |   
isCustomElement | 指定一个方法,用来识别在 `Vue` 之外定义的自定义元素。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#iscustomelement) | √ | √ | √ |   
optionMergeStrategies | 为自定义选项定义合并策略。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#optionmergestrategies) | √ | √ | √ |   
performance | 设置为 `true` 以在浏览器开发工具的 `performance/timeline` 面板中启用对组件初始化、编译、渲染和更新的性能追踪。[详情 (opens new window)](https://v3.cn.vuejs.org/api/application-config.html#performance) | √ | x | x | 只在Web环境下支持  
  
#### 应用 API

在 Vue 3 中,改变全局 `Vue` 行为的 `API` 现在被移动到了由新的 `createApp`
方法所创建的应用实例上。此外,现在它们的影响仅限于该特定应用实例:
```js
    import { createApp } from 'vue'
    
    const app = createApp({})

调用 createApp 返回一个应用实例。该实例提供了一个应用上下文。应用实例挂载的整个组件树共享相同的上下文,该上下文提供了之前在 Vue 2.x 中“全局”的配置。

另外,由于 createApp 方法返回应用实例本身,因此可以在其后链式调用其它方法,这些方法可以在以下部分中找到。

应用 API描述H5App端微信小程序
component注册或检索全局组件。详情 (opens new window)
config包含应用配置的对象。详情 (opens new window)
directive注册或检索全局指令。详情 (opens new window)x
mixin在整个应用范围内应用混入。详情 (opens new window)
provide设置一个可以被注入到应用范围内所有组件中的值。详情 (opens new window)
use安装 Vue.js 插件。详情 (opens new window)

全局 API

全局 API描述H5App端微信小程序
createApp返回一个提供应用上下文的应用实例。应用实例挂载的整个组件树共享同一个上下文。详情 (opens new window)
h返回一个”虚拟节点“,通常缩写为 VNode:一个普通对象,其中包含向 Vue 描述它应在页面上渲染哪种节点的信息,包括所有子节点的描述。详情 (opens new window)xx
defineComponent从实现上看,defineComponent 只返回传递给它的对象。但是,就类型而言,返回的值有一个合成类型的构造函数,用于手动渲染函数、TSXIDE 工具支持。详情 (opens new window)xx
defineAsyncComponent创建一个只有在需要时才会加载的异步组件。详情 (opens new window)xx
resolveComponent如果在当前应用实例中可用,则允许按名称解析 component。返回一个 Component详情 (opens new window)xx
resolveDynamicComponent允许使用与 component :is="" 相同的机制来解析一个 component详情 (opens new window)xx
resolveDirective如果在当前应用实例中可用,则允许通过其名称解析一个 directive。返回一个 Directive详情 (opens new window)xx
withDirectives允许将指令应用于 VNode。返回一个包含应用指令的 VNode详情 (opens new window)xx
createRenderercreateRenderer 函数接受两个泛型参数: HostNodeHostElement,对应于宿主环境中的 NodeElement 类型。详情 (opens new window)xx
nextTick将回调推迟到下一个 DOM 更新周期之后执行。在更改了一些数据以等待 DOM 更新后立即使用它。详情 (opens new window)xx

选项/Data

Data描述H5App端微信小程序
data返回组件实例的 data 对象的函数。详情 (opens new window)
propsprops 可以是数组或对象,用于接收来自父组件的数据。详情 (opens new window)
computed计算属性将被混入到组件实例中。所有 gettersetterthis 上下文自动地绑定为组件实例。详情 (opens new window)
methodsmethods 将被混入到组件实例中。可以直接通过 VM 实例访问这些方法,或者在指令表达式中使用。方法中的 this 自动绑定为组件实例。详情 (opens new window)
watch一个对象,键是需要观察的表达式,值是对应回调函数。值也可以是方法名,或者包含选项的对象。详情 (opens new window)
emitsemits 可以是数组或对象,从组件触发自定义事件,emits 可以是简单的数组,或者对象作为替代,允许配置和事件验证。详情 (opens new window)

选项/DOM

DOM描述H5App端微信小程序说明
template一个字符串模板作为 component 实例的标识使用。详情 (opens new window)xxuni-app使用的vue是只包含运行时的版本
render字符串模板的另一种选择,允许你充分利用 JavaScript 的编程功能。详情 (opens new window)xx-

选项/生命周期钩子

生命周期钩子描述H5App端微信小程序
beforeCreate在实例初始化之后,数据观测(data observer)event/watcher 事件配置之前被调用。详情 (opens new window)
created在实例创建完成后被立即调用。详情 (opens new window)
beforeMount在挂载开始之前被调用:相关的 render 函数首次被调用。详情 (opens new window)
mounted实例被挂载后调用,这时 Vue.createApp({}).mount() 被新创建的 vm.$el 替换了。详情 (opens new window)
beforeUpdate数据更新时调用,发生在虚拟 DOM 打补丁之前。详情 (opens new window)
updated由于数据更改导致的虚拟 DOM 重新渲染和打补丁,在这之后会调用该钩子。详情 (opens new window)
activatedkeep-alive 缓存的组件激活时调用。详情 (opens new window)x
deactivatedkeep-alive 缓存的组件停用时调用。详情 (opens new window)x
beforeUnmount在卸载组件实例之前调用。在这个阶段,实例仍然是完全正常的。详情 (opens new window)
unmounted卸载组件实例后调用。调用此钩子时,组件实例的所有指令都被解除绑定,所有事件侦听器都被移除,所有子组件实例被卸载。详情 (opens new window)
errorCaptured当捕获一个来自子孙组件的错误时被调用。此钩子会收到三个参数:错误对象、发生错误的组件实例以及一个包含错误来源信息的字符串。详情 (opens new window)
renderTracked跟踪虚拟 DOM 重新渲染时调用。钩子接收 debugger event 作为参数。此事件告诉你哪个操作跟踪了组件以及该操作的目标对象和键。详情 (opens new window)
renderTriggered当虚拟 DOM 重新渲染为 triggered.SimilarlyrenderTracked,接收 debugger event 作为参数。此事件告诉你是什么操作触发了重新渲染,以及该操作的目标对象和键。详情 (opens new window)

选项/资源

资源描述H5App端微信小程序
directives包含组件实例可用指令的哈希表。详情 (opens new window)x
components包含组件实例可用组件的哈希表。详情 (opens new window)

选项/组合

组合描述H5App端微信小程序
mixins接收一个混入对象的数组。这些混入对象可以像正常的实例对象一样包含实例选项,这些选项将会被合并到最终的选项中,使用特定的选项合并逻辑。详情 (opens new window)
extends允许声明扩展另一个组件 (可以是一个简单的选项对象或构造函数)。这主要是为了便于扩展单文件组件。详情 (opens new window)
provide / inject这对选项需要一起使用,以允许一个祖先组件向其所有子孙后代注入一个依赖,不论组件层次有多深,并在起上下游关系成立的时间里始终生效。详情 (opens new window)
setupsetup 函数是一个新的组件选项。它作为在组件内部使用组合式 API 的入口点。详情 (opens new window)

选项/杂项

杂项描述H5App端微信小程序
name允许组件模板递归地调用自身。注意,组件在全局用 Vue.createApp({}).component({}) 注册时,全局 ID 自动作为组件的 name详情 (opens new window)
delimiters设置用于模板内文本插入的分隔符。详情 (opens new window)xx
inheritAttrs默认情况下父作用域的不被认作 propsattribute 绑定 (attribute bindings) 将会“回退”且作为普通的 HTML attribute 应用在子组件的根元素上。当撰写包裹一个目标元素或另一个组件的组件时,通过设置 inheritAttrsfalse,这些默认行为将会被去掉。详情 (opens new window)x

实例 property

实例 property描述H5App端微信小程序说明
$data组件实例观察的数据对象。组件实例代理了对其 data 对象 property 的访问。详情 (opens new window)
$props当前组件接收到的 props 对象。组件实例代理了对其 props 对象 property 的访问。详情 (opens new window)
$el组件实例使用的根 DOM 元素。详情 (opens new window)xx
$options用于当前组件实例的初始化选项。需要在选项中包含自定义 property 时会有用处。详情 (opens new window)
$parent父实例,如果当前实例有的话。详情 (opens new window)H5端 viewtext 等内置标签是以 Vue 组件方式实现,$parent 会获取这些到内置组件,导致的问题是 this.$parent 与其他平台不一致,解决方式是使用 this.$parent.$parent 获取或自定义组件根节点由 view 改为 div
$root当前组件树的根组件实例。如果当前实例没有父实例,此实例将会是其自己。详情 (opens new window)
$slots用来访问被插槽分发的内容。每个具名插槽有其相应的 property (例如:v-slot:foo 中的内容将会在 this.$slots.foo 中被找到)。详情 (opens new window)x
$refs一个对象,持有注册过 ref attribute 的所有 DOM 元素和组件实例。详情 (opens new window)非H5端只能用于获取自定义组件,不能用于获取内置组件实例(如:viewtext
$attrs包含了父作用域中不作为组件 props 或自定义事件。详情 (opens new window)x-

实例方法

实例方法描述H5App端微信小程序
$watch侦听组件实例上的响应式 property 或函数计算结果的变化。详情 (opens new window)
$emit触发当前实例上的事件。附加参数都会传给监听器回调。详情 (opens new window)
$forceUpdate迫使组件实例重新渲染。注意它仅仅影响实例本身和插入插槽内容的子组件,而不是所有子组件。详情 (opens new window)
$nextTick将回调延迟到下次 DOM 更新循环之后执行。在修改数据之后立即使用它,然后等待 DOM 更新。详情 (opens new window)

指令

Vue 指令描述H5App端微信小程序说明
v-text更新元素的 textContent详情 (opens new window)x
v-html更新元素的 innerHTML详情 (opens new window)微信小程序会被转成 rich-text
v-show根据表达式的真假值,切换元素的 display CSS property详情 (opens new window)
v-if根据表达式的真假值来有条件地渲染元素。 详情 (opens new window)
v-elsev-if 或者 v-else-if 添加“else 块”详情 (opens new window)
v-else-if表示 v-if“else if 块”。可以链式调用。 详情 (opens new window)
v-for基于源数据多次渲染元素或模板块。 详情 (opens new window)
v-on绑定事件监听器。 详情 (opens new window)
v-bind动态地绑定一个或多个 attribute,或一个组件 prop 到表达式。 详情 (opens new window)
v-model在表单控件或者组件上创建双向绑定。 详情 (opens new window)
v-slot提供具名插槽或需要接收 prop 的插槽。 详情 (opens new window)
v-pre跳过这个元素和它的子元素的编译过程。 详情 (opens new window)x
v-cloak这个指令保持在元素上直到关联组件实例结束编译。 详情 (opens new window)xx
v-once只渲染元素和组件一次。 详情 (opens new window)x
v-isDOM 内模板使用时,模板受原生 HTML 解析规则的约束。 详情 (opens new window)xx-

特殊属性

特殊属性描述H5App端微信小程序说明
keykey 的特殊 attribute 主要用在 Vue 的虚拟 DOM 算法,在新旧 nodes 对比时辨识 VNodes详情 (opens new window)
refref 被用来给元素或子组件注册引用信息。 详情 (opens new window)非 H5 平台只能获取 vue 组件实例不能获取到内置组件实例
is使用动态组件 (opens new window)详情 (opens new window)x-

内置组件

内置组件描述H5App端微信小程序
component渲染一个“元组件”为动态组件。依 is 的值,来决定哪个组件被渲染。 详情 (opens new window)x
transition作为单个元素/组件的过渡效果。 详情 (opens new window)xx
transition-group作为多个元素/组件的过渡效果。 详情 (opens new window)xx
keep-alive包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们,主要用于保留组件状态或避免重新渲染。 详情 (opens new window)xx
slot作为组件模板之中的内容分发插槽。slot 元素自身将被替换。 详情 (opens new window)
teleport将模板的一部分移动到 DOMVue app 之外的其他位置。 详情 (opens new window)xx

响应性 API

响应性基础 API
响应性基础 API描述H5App端微信小程序
reactive返回对象的响应式副本。详情 (opens new window)
readonly获取一个对象 (响应式或纯对象) 或 ref 并返回原始代理的只读代理。详情 (opens new window)
isProxy检查对象是 reactive 还是 readonly创建的代理。详情 (opens new window)
isReactive检查对象是否是 reactive创建的响应式 proxy详情 (opens new window)
isReadonly检查对象是否是由readonly创建的只读代理。详情 (opens new window)
toRaw返回 reactivereadonly 代理的原始对象。详情 (opens new window)
markRaw标记一个对象,使其永远不会转换为代理。返回对象本身。详情 (opens new window)
shallowReactive创建一个响应式代理,该代理跟踪其自身 property 的响应性,但不执行嵌套对象的深度响应式转换 (暴露原始值)。详情 (opens new window)
shallowReadonly创建一个代理,使其自身的 property 为只读,但不执行嵌套对象的深度只读转换 (暴露原始值)。详情 (opens new window)
Refs
Refs描述H5App端微信小程序
ref接受一个内部值并返回一个响应式且可变的 ref 对象。ref 对象具有指向内部值的单个 property .value详情 (opens new window)
unref如果参数为 ref,则返回内部值,否则返回参数本身。这是 val = isRef(val) ? val.value : val详情 (opens new window)
toRef可以用来为源响应式对象上的 property 性创建一个 ref。然后可以将 ref 传递出去,从而保持对其源 property 的响应式连接。详情 (opens new window)
toRefs将响应式对象转换为普通对象,其中结果对象的每个 property 都是指向原始对象相应 propertyref详情 (opens new window)
isRef检查值是否为ref对象详情 (opens new window)
customRef创建一个自定义的 ref,并对其依赖项跟踪和更新触发进行显式控制。详情 (opens new window)
shallowRef创建一个 ref,它跟踪自己的 .value 更改,但不会使其值成为响应式的。详情 (opens new window)
triggerRef手动执行与 shallowRef 关联的任何效果。详情 (opens new window)

Computed 与 watch

Computed 与 watch描述H5App端微信小程序
computed使用 getter 函数,并为从 getter 返回的值返回一个不变的响应式 ref 对象。详情 (opens new window)
watchEffect在响应式地跟踪其依赖项时立即运行一个函数,并在更改依赖项时重新运行它。详情 (opens new window)
watchwatch API 与选项式 API this.$watch (以及相应的 watch 选项) 完全等效。watch 需要侦听特定的 data 源,并在单独的回调函数中副作用。详情 (opens new window)

组合式 API

组合式 API描述H5App端微信小程序
setup一个组件选项,在创建组件之前执行,一旦 props 被解析,并作为组合式 API 的入口点。详情 (opens new window)
生命周期钩子可以使用直接导入的 onX 函数注册生命周期钩子。详情 (opens new window)
Provide / Injectprovide 和 inject 启用依赖注入。只有在使用当前活动实例的 setup() 期间才能调用这两者。详情 (opens new window)
getCurrentInstance允许访问对高级使用或库创建者有用的内部组件实例。详情 (opens new window)

8 Vue2升级Vue3

main.js

    // 之前 - Vue 2
    import Vue from 'vue'
    import App from './App'
    Vue.config.productionTip = false    // vue3 不再需要
    App.mpType = 'app'    // vue3 不再需要
    const app = new Vue({
    ...App
    })
    app.$mount()
    import App from './App'
    import { createSSRApp } from 'vue'
    // 不能修改导出的 createApp 方法名,不能修改从 Vue 中导入的 createSSRApp。
    export function createApp() {
      const app = createSSRApp(App)
      return {
          app
      }
    }

环境变量

    // 配置环境变量
    // 根目录.env文件 必须 VUE_APP_ 开头
    VUE_APP_SOME_KEY = 123
    
    // 获取环境变量
    process.env.NODE_ENV         // 应用运行的模式
    process.env.VUE_APP_SOME_KEY // 123
    
    // vue3
    // 配置环境变量
    // 根目录.env文件 必须 VITE_ 开头
    VITE_SOME_KEY = 123
    
    // 获取环境变量
    process.env.NODE_ENV          // 应用运行的模式
    import.meta.env.VITE_SOME_KEY // 123

全局属性

例如:全局网络请求

    // 之前 - Vue 2
    Vue.prototype.$http = () => {};
    
    // 之后 - Vue 3
    const app = createApp({});
    app.config.globalProperties.$http = () => {};

插件使用

例如:使用 vuex 的 store

    // 之前 - Vue 2
    import store from "./store";
    Vue.prototype.$store = store;
    
    // 之后 - Vue 3
    import store from "./store";
    const app = createApp(App);
    app.use(store);

项目根目录必需创建 index.html 文件

粘贴复制如下内容:

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <meta charset="UTF-8" />
        <meta
          name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
        />
        <title></title>
        <!--preload-links-->
        <!--app-context-->
      </head>
      <body>
        <div id="app"><!--app-html--></div>
        <script type="module" src="/main.js"></script>
      </body>
    </html>

只支持使用 ES6 模块规范

commonJS 需改为 ES6 模块规范

模块导入

    // 之前 - Vue 2, 使用 commonJS
    var utils = require("../../../common/util.js");
    
    // 之后 - Vue 3, 只支持 ES6 模块
    import utils from "../../../common/util.js";

模块导出

    // 之前 - Vue 2, 依赖如使用 commonJS 方式导出
    module.exports.X = X;
    
    // 之后 - Vue 3, 只支持 ES6 模块
    export default { X };

vuex 用法

    // vue2
    import Vue from "vue";
    import Vuex from "vuex";
    Vue.use(Vuex);
    const store = new Vuex.Store({
      state: {},
    });
    export default store;
    
    // vue3
    import { createStore } from "vuex";
    const store = createStore({
      state: {},
    });
    export default store;

生命周期的适配

在 Vue3 中组件卸载的生命周期被重新命名

  • destroyed 修改为 unmounted
  • beforeDestroy 修改为 beforeUnmount

事件的适配

Vue3 现在提供了一个emits选项,类似于现有props选项。此选项可用于定义组件可以向其父对象发出的事件, 更多 (opens new window)

强烈建议使用emits记录每个组件发出的所有事件。

这一点特别重要,因为去除了.native修饰符。emits 现在在未使用声明的事件的所有侦听器都将包含在组件的中$attrs,默认情况下,该侦听器将绑定到组件的根节点。

    <template>
      <button @click="onClick">OK</button>
    </template>
    <script>
      export default {
        emits: ["click"],
        methods: {
          onClick() {
            this.$emit("click", "OK");
          },
        },
      };
    </script>

Vue3 项目部分小程序端事件延迟或调用失败

可在执行事件的元素上添加 data-eventsync="true" 属性以解决此问题,如:

    <template>
      <button @click="onClick" data-eventsync="true">OK</button>
    </template>

v-model 的适配

Vue3 的 v-model 相对 Vue2 来说 ,有了较大的改变。可以使用多 model,相应语法也有变化。更多 (opens new window)

修改 modelValue

用于自定义组件时,Vue3 v-model prop 和事件默认名称已更改 props.value 修改为 props.modelValue ,event.value 修改为 update:modelValue

    export default {
      props: {
        // value:String,
        // 替换 value 为 modelValue
        modelValue: String,
      },
    };

事件返回

将之前的 this.$emit('input') 修改为 this.$emit('update:modelValue') ,vue3 中将省略这一步骤

自定义组件上的 v-model 相当于传递了 modelValue prop 并接收抛出的 update:modelValue 事件:

    <ChildComponent v-model="pageTitle" />
    
    <!-- 是以下的简写: -->
    
    <ChildComponent
      :modelValue="pageTitle"
      @update:modelValue="pageTitle = $event"
    />

若需要更改 model 名称,作为组件内 model 选项的替代,现在我们可以将一个 argument 传递给 v-model:

    <ChildComponent v-model:title="pageTitle" />
    
    <!-- 是以下的简写: -->
    
    <ChildComponent :title="pageTitle" @update:title="pageTitle = $event" />

插槽的适配

Vue3 将不支持 slot="xxx" 的用法 ,请使用 v-slot:xxx 用法。[更多 (opens new window)](https://v3.cn.vuejs.org/guide/component- slots.html#%E5%85%B7%E5%90%8D%E6%8F%92%E6%A7%BD)

    <!--  Vue2 支持的用法 -->
    <uni-nav-bar>
      <view slot="left" class="city">
        <!-- ... -->
      </view>
    </uni-nav-bar>
    <!--  Vue3 支持的用法 -->
    <uni-nav-bar>
      <template v-slot:left>
        <view class="city">
          <!-- ... -->
        </view>
      </template>
    </uni-nav-bar>

不再支持过滤器

从 Vue 3.0 开始,过滤器已删除,不再支持,建议用方法调用或计算属性替换它们。更多 (opens new window)

API Promise 化 调用结果的方式

在 Vue3 中,处理 API Promise 化 调用结果的方式不同于 Vue2。更多 (opens new window)

  • Vue3 中,调用成功会进入 then 方法,调用失败会进入 catch 方法
  • Vue2 中,调用无论成功还是失败,都会进入 then 方法,返回数据的第一个参数是错误对象,第二个参数是返回数据

转换方法

    // Vue 2 转 Vue 3, 在 main.js 中写入以下代码即可
    function isPromise(obj) {
      return (
        !!obj &&
        (typeof obj === "object" || typeof obj === "function") &&
        typeof obj.then === "function"
      );
    }
    
    uni.addInterceptor({
      returnValue(res) {
        if (!isPromise(res)) {
          return res;
        }
        return new Promise((resolve, reject) => {
          res.then((res) => {
            if (res[0]) {
              reject(res[0]);
            } else {
              resolve(res[1]);
            }
          });
        });
      },
    });
    // Vue 3 转 Vue 2, 在 main.js 中写入以下代码即可
    function isPromise(obj) {
      return (
        !!obj &&
        (typeof obj === "object" || typeof obj === "function") &&
        typeof obj.then === "function"
      );
    }
    
    uni.addInterceptor({
      returnValue(res) {
        if (!isPromise(res)) {
          return res;
        }
        const returnValue = [undefined, undefined];
        return res
          .then((res) => {
            returnValue[1] = res;
          })
          .catch((err) => {
            returnValue[0] = err;
          })
          .then(() => returnValue);
      },
    });

生命周期钩子的组合式 API 使用方式

在 Vue3 组合式 API 中,也需要遵循 uni-app 生命周期钩子规范, 如 onLaunch 等应用生命周期仅可在 App.vue 中监听,使用中请注意生命周期钩子的适用范围。查看全部生命周期钩子 (opens new window)

只能在 <script setup> 单文件语法糖或 setup() 方法中使用生命周期钩子,以 A 页面跳转 B 页面传递参数为例:

    // 从 A 页面跳转 B 页面时传递参数 ?id=1&name=uniapp,xxx 为跳转的页面路径
    //uni.navigateTo({
    //  url: 'xxx?id=1&name=uniapp'
    //})
    
    // 方法一:在 B 页面 <script setup> 中
    <script setup>
      import {
        onLoad,
        onShow
      } from "@dcloudio/uni-app";
    
      // onLoad 接受 A 页面传递的参数
      onLoad((option) => {
        console.log("B 页面 onLoad:", option); //B 页面 onLoad: {id: '1', name: 'uniapp'}
      });
    
      onShow(() => {
        console.log("B 页面 onShow");
      });
    </script>
    // 方法二:在 B 页面 setup() 中
    <script>
      import {
        onLoad,
        onShow,
      } from "@dcloudio/uni-app";
    
      export default {
        setup() {
          // onLoad 接受 A 页面传递的参数
          onLoad((option) => {
            console.log("B 页面 onLoad:", option); //B 页面 onLoad: {id: '1', name: 'uniapp'}
          });
    
          onShow(() => {
            console.log("B 页面 onShow");
          });
        }
      }
    </script>

$mp调整为 $scope

在 Vue3 中,this 对象下的 $mp 调整为 $scope

在 nvue 使用 Vuex

在 Vue3 中,如果 nvue 使用了 Vuex 的相关 API,需要在 main.js 的 createApp 的返回值中 return 一下 Vuex 示例:

    import Vuex from "vuex";
    export function createApp() {
      const app = createSSRApp(App);
      app.use(store);
      return {
        app,
        Vuex, // 如果 nvue 使用 vuex 的各种map工具方法时,必须 return Vuex
      };
    }

需主动开启 sourcemap

App,小程序端源码调试,需要在 vite.config.js 中主动开启 sourcemap

    import { defineConfig } from "vite";
    import uni from "@dcloudio/vite-plugin-uni";
    
    /**
     * @type {import('vite').UserConfig}
     */
    
    export default defineConfig({
      build: {
        sourcemap: true,
      },
    
      plugins: [uni()],
    });

小程序平台中监听原生的点击事

在 vue3 的小程序平台中,监听原生的点击事件可以先使用 tap。 在 vue3 中,移除了.native 修饰符,所以编译器无法预知 click 是要触发原生事件,还是组件的自定义事件,故并未转换成小程序的 tap 事件。

vue3 支持的手机版本最低到多少

vue3 支持的范围是:Android > 4.4(具体因系统 webview 版本而异,原生安卓系统升级过系统 webview 一般 5.0 即可,国产安卓系统未使用 x5 内核时一般需 7.0 以上), ios >= 10

Android < 4.4,配置 X5 内核支持,首次需要联网下载,可以配置下载 X5 内核成功后启动应用,详情 (opens new window)

vue3 nvue 暂不支持 recycle-list 组件

vue3 nvue 暂不支持 recycle-list 组件

h5 平台发行时,会默认启动摇树

vue3 在 h5 平台发行时,为了优化包体积大小,会默认启动摇树,仅打包明确使用的 api, 如果要关闭摇树,可以在 manifest.json 中配置:

    "h5": {
        "optimization": {
            "treeShaking": {
                "enable": false
            }
        }
    }

通过 props 来获取页面参数

vue3 全平台新增:通过 props 来获取页面参数的使用方式

    <script setup>
      // 页面可以通过定义 props 来直接接收 url 传入的参数
      // 如:uni.navigateTo({ url: '/pages/index/index?id=10' })
      const props = defineProps({
        id: String,
      });
      console.log("id=" + props.id); // id=10
    </script>
    <script>
      // 页面可以通过定义 props 来直接接收 url 传入的参数
      // 如:uni.navigateTo({ url: '/pages/index/index?id=10' })
      export default {
        props: {
          id: {
            type: String,
          },
        },
        setup(props) {
          console.log("id=" + props.id); // id=10
        },
      };
    </script>

9 跨平台兼容

关于各端的管理规则需要耐心学习

每个端,有每个端的管理规则,这不是uni-app在技术层面上可以抹平的:

  • 比如H5端的浏览器有跨域限制;
  • 比如微信小程序会强制要求https链接,并且所有要联网的服务器域名都要配到微信的白名单中;
  • 比如App端,iOS对隐私控制和虚拟支付控制非常严格;
  • 比如App端,Android、国产rom各种兼容性差异,尤其是因为谷歌服务被墙,导致的push、定位等开发混乱的坑

H5正常但App异常的可能性

  • body的元素选择器请改为page,同样,div和ul和li等改为view、span和font改为text、a改为navigator、img改为image...
  • 使用了非H5端不支持的API 小程序和App的js运行在jscore下而不是浏览器里,没有浏览器专用的js对象,比如document、xmlhttp、cookie、window、location、navigator、localstorage、websql、indexdb、webgl等对象。

H5正常但小程序异常的可能性

  • 同上
  • v-html在h5和app-vue均支持,但小程序不支持
  • 小程序要求连接的网址都要配白名单

小程序正常但App异常的可能性

  • vue页面在App端的渲染引擎默认是系统webview(不是手机自带浏览器,是rom的webview),在较老的手机上,比如Android4.4、5.0或iOS8,一些新出的css语法是不支持的。注意这不意味着不能使用flex,Android4.4也支持flex,只是不要使用太新的css。可以找Android4.4手机或使用pc模拟器实际测试下,大多数国产Android模拟器都是4.4或5.0

小程序不存在浏览器兼容问题,它内置了几十M自己的定制webview。所以如果你的H5和小程序界面正常,而App界面异常,大多是因为css兼容性

解决这类问题:

放弃老款手机支持 不用使用太新的css语法,可以在caniuse查询 从 uni-app 2.5.3 起,Android端支持引入腾讯x5浏览器内核,可以抹平低端Android的浏览器兼容性问题

小程序或App正常,但H5异常的可能性

  • 在 uni-app 2.4.7 以前,H5端不支持微信小程序自定义组件,即 wxcomponents 下的组件,此时可能产生兼容问题。从 2.4.7 起,H5也支持微信自定义组件,不再存在这这方面兼容问题。
  • App端使用了App特有的API和功能,比如plus、Native.js、subNVue、原生插件等
  • 使用了小程序专用的功能,比如微信卡券、小程序插件、微信小程序云开发。对于云开发,建议使用可跨端的uniCloud

App正常,小程序、H5异常的可能性

  • 代码中使用了App端特有的plus、Native.js、subNVue、原生插件等功能

区别于传统 web 开发的注意

JS注意

  • 非H5端,不能使用浏览器自带对象,比如document、window、localstorage、cookie等,更不能使用jquery等依赖这些浏览器对象的框架。因为各家小程序快应用都不支持这些对象。
  • 没有这些浏览器自带对象并不影响业务开发,uni提供的api足够完成业务。
  • uni的api在编译到web平台运行时,其实也会转为浏览器的js api。
  • App端若要使用操作window、document的库,需要通过renderjs来实现。
  • uni的api是多端可用的。在条件编译区,每个平台的专有api也可以使用,比如wx.、plus.等api可以分别在微信下和app下使用。
  • 出于降低小程序向uni- app迁移成本的考虑,wx的api在app里也可以直接运行,比如写wx.request和uni.request是一样的,但仍然建议仅在微信的条件编译区使用wx的api。

Tag注意

  • uni-app的tag同小程序的tag,和HTML的tag不一样,比如div要改成view,span要改成text、a要改成navigator。
  • 出于降低h5应用向uni-app迁移成本的考虑,写成div、span也可以运行在app和小程序上,因为uni-app编译器会把这些HTML标签编译为小程序标签。但仍然建议养成新习惯。

Css注意

  • 虽然大部分css样式在微信小程序和app中都可以支持,但推荐使用flex布局模型,这种布局更灵活高效且支持更多平台(比如nvue、快应用只支持flex布局)
  • 单位方面,uni-app默认为rpx。这是一种可跨端的通用单位

工程目录注意

  • 页面文件:放到pages目录下;推荐方案:新建一个页面目录,然后创建一个目录同名的.vue文件,如/pages/list/list.vue,接着在pages.json里完成注册。这与小程序的策略相同。
  • 自定义组件:放到component目录
  • 静态资源:如图片,固定放到static目录下。这是webpack的规则

H5 开发注意

H5 发布到服务器注意

  • 配置发行后的路径(发行在网站根目录可不配置),比如发行网站路径是 www.xxx.com/html5,在 manifest.json 文件内编辑 h5 节点,router 下增加 base 属性为 html5

  • 点击菜单 发行-> H5
  • 在当下项目下的 unpackage/dist/build/h5 目录找到出的资源,部署服务器(或者使用本地服务器预览),如需部署到相对路径(支持本地file协议打开)参考:https://ask.dcloud.net.cn/article/37432

引用第三方 js 的方式:

  • 通过 npm 引入(通过条件编译,只有是 h5 平台才 import 相应的库)
  • 在 manifest.json 文件编辑 h5 节点的 template 属性,填写 html 模版路径,在 html 模版里面可以使用 script 的方式引入三方的 js,如下示例是加了百度统计的 html 模板部分代码
    <!-- ... -->
    <body>
                <noscript>
                    <strong>Please enable JavaScript to continue.</strong>
                </noscript>
                <div id="app"></div>
                <!-- built files will be auto injected -->
                <script>
                    var _hmt = _hmt || [];
                    (function() {
                        var hm = document.createElement("script");
                        hm.src = "https://hm.baidu.com/hm.js?xxxxxx";
                        var s = document.getElementsByTagName("script")[0];
                        s.parentNode.insertBefore(hm, s);
                    })();
                </script>
    </body>
    <!-- ... -->
  • H5 版 uni-app 全支持 vue 语法,所以可能造成部分写法在 H5 端生效,在小程序或 App 端不生效
  • H5 校验了更严格的 vue 语法,有些写法不规范会报警,比如: data 后面写对象会报警,必须写 function;不能修改 props 的值;组件最外层 template 节点下不允许包含多个节点等
  • 编译为 H5 版后生成的是单页应用(SPA)
  • 如果遇到跨域造成js无法联网,注意网络请求(request、uploadFile、downloadFile等)在浏览器存在跨域限制,解决方案有详见:https://ask.dcloud.net.cn/article/35267
  • APP 和小程序的导航栏和 tabbar 均是原生控件,元素区域坐标是不包含原生导航栏和 tabbar 的;而 H5 里导航栏和 tabbar 是 div 模拟实现的,所以元素坐标会包含导航栏和tabbar的高度。为了优雅的解决多端高度定位问题,uni-app 新增了2个css变量:--window-top 和 --window-bottom,这代表了页面的内容区域距离顶部和底部的距离。举个实例,如果你想在原生tabbar 上方悬浮一个菜单,之前写 bottom:0。这样的写法编译到 h5 后,这个菜单会和 tabbar 重叠,位于屏幕底部。而改为使用 bottom:var(--window-bottom),则不管在 app 下还是在h5下,这个菜单都是悬浮在 tabbar 上浮的。这就避免了写条件编译代码。当然仍然也可以使用 H5 的条件编译处理界面的不同
  • CSS 內使用 vh 单位的时候注意 100vh 包含导航栏,使用时需要减去导航栏和 tabBar 高度,部分浏览器还包含浏览器操作栏高度,使用时请注意
  • 正常支持 rpx,px 是真实物理像素。暂不支持通过设 manifest.json 的 "transformPx" : true,把 px 当动态单位使用
  • 使用罗盘、地理位置、加速计等相关接口需要使用 https 协议,本地预览(localhost)可以使用 http 协议
  • 组件内(页面除外)不支持 onLoad、onShow 等页面生命周期
  • 为避免和内置组件冲突,自定义组件请加上前缀(但不能是 u 和 uni)。比如可使用的自定义组件名称:my-view、m-input、we-icon,例如不可使用的自定义组件名称:u-view、uni-input,如果已有项目使用了可能造成冲突的名称,请修改名称,另外微信小程序下自定义组件名称不能以 wx 开头

小程序开发注意

vendor.js 过大的处理方式

小程序工具提示vendor.js过大,已经跳过es6向es5转换。这个转换问题本身不用理会,因为vendor.js已经是es5的了。

关于体积控制,参考如下

  • HBuilderX创建的项目勾选运行-->运行到小程序模拟器-->运行时是否压缩代码
  • cli创建的项目可以在package.json中添加参数--minimize,示例:"dev:mp-weixin": "cross-env NODE_ENV=development UNI_PLATFORM=mp-weixin vue-cli-service uni-build --watch --minimize"
  • 使用分包优化

建议关注微信小程序当前bug列表 (opens new window),对已知Bug,想办法避让。

10 uni-app存储

uni- app的存储方案比5+app要少,因为cookie、localstorage、sessionstorage、websql、indexedDB只有h5端支持,其他端都不支持。

  • uni.storage的键值对存储,这个是全端支持的。

  • uni-app的Storage在不同端的实现不同,uni.storage在app侧,映射为plus.storage;h5侧映射为localstorage;各个小程序平台映射为其自带的storage键值对存储:

  • H5端为localStorage,浏览器限制5M大小,是缓存概念,可能会被清理

  • App端为原生的plus.storage,无大小限制,不是缓存,持久化

  • 各个小程序端为其自带的storage api,数据存储生命周期跟小程序本身一致,即除用户主动删除或超过一定时间被自动清理,否则数据都一直可用。

  • 微信小程序单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。

  • 支付宝小程序单条数据转换成字符串后,字符串长度最大200*1024。同一个支付宝用户,同一个小程序缓存总上限为10MB。

  • 百度、头条小程序文档未说明大小限制

11 判断平台

平台判断有 2 种场景,一种是在编译期判断,一种是在运行期判断。

  • 编译期判断 编译期判断,即条件编译,不同平台在编译出包后已经是不同的代码
    // #ifdef H5
    alert('只有h5平台才有alert方法');
    // #endif

如上代码只会编译到 H5 的发行包里,其他平台的包不会包含如上代码

  • 运行期判断 运行期判断是指代码已经打入包中,仍然需要在运行期判断平台,此时可使用 uni.getSystemInfoSync().platform 判断客户端环境是 Android、iOS 还是小程序开发工具(在百度小程序开发工具、微信小程序开发工具、支付宝小程序开发工具中使用 uni.getSystemInfoSync().platform 返回值均为 devtools)
    switch (uni.getSystemInfoSync().platform) {
    	case 'android':
    		console.log('运行Android上');
    		break;
    	case 'ios':
    		console.log('运行iOS上');
    		break;
    	default:
    		console.log('运行在开发者工具上');
    		break;
    }

如有必要,也可以在条件编译里自己定义一个变量,赋不同值。在后续运行代码中动态判断环境

12 条件编译

什么是编译器

uni-app能实现一套代码、多端运行,核心是通过编译器 + 运行时实现的

  • 编译器:将uni-app统一代码编译生成每个平台支持的特有代码;如在小程序平台,编译器将.vue文件拆分生成wxmlwxssjs等代码。
  • 运行时:动态处理数据绑定、事件代理,保证Vue和平台宿主数据的一致性

uni-app项目根据所依赖的Vue版本不同,编译器的实现也不同:

条件编译

条件编译是用特殊的注释作为标记,在编译时根据这些特殊的注释,将注释里面的代码编译到不同平台。

**写法:**以 #ifdef 或 #ifndef 加 %PLATFORM% 开头,以 #endif 结尾。

  • #ifdef:if defined 仅在某平台存在
  • #ifndef:if not defined 除了某平台均存在
  • %PLATFORM% :平台名称
条件编译写法说明
#ifdef APP-PLUS 需条件编译的代码 #endif仅出现在 App 平台下的代码
#ifndef H5 需条件编译的代码 #endif除了 H5 平台,其它平台均存在的代码
#ifdef H5

%PLATFORM% 可取值如下:

生效条件
VUE3HBuilderX 3.2.0+ 详情 (opens new window)
APP-PLUSApp
APP-PLUS-NVUE或APP-NVUEApp nvue 页面
APP-ANDROIDApp Android 平台 仅限 uts文件
APP-IOSApp iOS 平台 仅限 uts文件
H5H5
MP-WEIXIN微信小程序
MP-ALIPAY支付宝小程序
MP-BAIDU百度小程序
MP-TOUTIAO字节跳动小程序
MP-LARK飞书小程序
MP-QQQQ小程序
MP-KUAISHOU快手小程序
MP-JD京东小程序
MP-360360小程序
MP微信小程序/支付宝小程序/百度小程序/字节跳动小程序/飞书小程序/QQ小程序/360小程序
QUICKAPP-WEBVIEW快应用通用(包含联盟、华为)
QUICKAPP-WEBVIEW-UNION快应用联盟
QUICKAPP-WEBVIEW-HUAWEI快应用华为

支持的文件

  • .vue
  • .js
  • .css
  • pages.json
  • 各预编译语言文件,如:.scss、.less、.stylus、.ts、.pug

注意:

  • 条件编译是利用注释实现的,在不同语法里注释写法不一样,js使用 // 注释、css 使用 /* 注释 */、vue/nvue 模板里使用 <!-- 注释 -->

  • 条件编译APP-PLUS包含APP-NVUE和APP-VUE,APP-PLUS-NVUE和APP-NVUE没什么区别,为了简写后面出了APP-NVUE ;

  • 使用条件编译请保证编译前编译后文件的正确性,比如json文件中不能有多余的逗号;

  • VUE3 需要在项目的 manifest.json 文件根节点配置 "vueVersion" : "3"

API 的条件编译

    // #ifdef  %PLATFORM%
    平台特有的API实现
    // #endif

示例,如下代码不会在 H5 平台上出现:

除了支持单个平台的条件编译外,还支持多平台 同时编译,使用 || 来分隔平台名称。

示例,如下代码会在 App 和 H5 平台上出现:

组件的条件编译

    <!--  #ifdef  %PLATFORM% -->
    平台特有的组件
    <!--  #endif -->

示例,如下公众号关注组件仅会在微信小程序中出现:

    <view>
        <view>微信公众号关注组件</view>
        <view>
            <!-- uni-app未封装,但可直接使用微信原生的official-account组件-->
            <!-- #ifdef MP-WEIXIN -->
    		        <official-account></official-account>
    		    <!-- #endif -->
        </view>
    </view>

样式的条件编译

    /*  #ifdef  %PLATFORM%  */
    平台特有样式
    /*  #endif  */

注意: 样式的条件编译,无论是 css 还是 sass/scss/less/stylus 等预编译语言中,必须使用 /*注释*/ 的写法。

正确写法

错误写法

pages.json 的条件编译

下面的页面,只有运行至 App 时才会编译进去。

不同平台下的特有功能,以及小程序平台的分包,都可以通过 pages.json 的条件编译来更好地实现。这样,就不会在其它平台产生多余的资源,进而减小包体积。

json的条件编译,如不同平台的key名称相同,cli项目下开发者自己安装的校验器会报错,需自行关闭这些校验器对json相同key的校验规则。如果使用HBuilderX的校验器,无需在意此问题,HBuilderX的语法校验器为此优化过

static 目录的条件编译

在不同平台,引用的静态资源可能也存在差异,通过 static 的条件编译可以解决此问题,static 目录下新建不同平台的专有目录

目录名称说明
app-plusApp
h5H5
mp-weixin微信小程序
mp-alipay支付宝小程序
mp-baidu百度小程序
mp-qqQQ小程序
mp-toutiao字节小程序
mp-lark飞书小程序
mp-kuaishou快手小程序
mp-jd京东小程序

专有目录下的静态资源只有在特定平台才会编译进去。

如以下目录结构,a.png 只有在微信小程序平台才会编译进去,b.png 在所有平台都会被编译。

    ┌─static
    │  ├─mp-weixin
    │  │  └─a.png
    │  └─b.png
    ├─main.js
    ├─App.vue
    ├─manifest.json
    └─pages.json

整体目录条件编译

如果想把各平台的页面文件更彻底的分开,也可以在uni-app项目根目录创建platforms目录,然后在下面进一步创建app-plusmp- weixin等子目录,存放不同平台的文件

注意

HBuilderX 支持

HBuilderX 为 uni-app 的条件编译提供了丰富的支持:

代码块支持

在 HBuilderX 中开发 uni-app 时,通过输入 ifdef 可快速生成条件编译的代码片段

语法高亮

在 HBuilderX 中对条件编译的代码注释部分提供了语法高亮,可分辨出写法是否正确,使得代码更加清晰(独立js文件需在编辑器右下角切换javascript es6+编辑器,独立css文件暂不支持高亮,但不高亮不影响使用)

正确注释和快速选中

在 HBuilderX 中,ctrl+alt+/ 即可生成正确注释(js:// 注释、css:/* 注释 */、vue/nvue模板: <!-- 注释 -->

点击 ifdefendif 可快速选中条件编译部分;点击左侧的折叠图标,可折叠条件编译部分代码。

注意

  • Android 和 iOS 平台不支持通过条件编译来区分,如果需要区分 Android、iOS 平台,请通过调用 uni.getSystemInfo 来获取平台信息。支持ifiosifAndroid代码块,可方便编写判断。
  • 有些跨端工具可以提供js的条件编译或多态,但这对于实际开发远远不够。uni-app不止是处理js,任何代码都可以多端条件编译,才能真正解决实际项目的跨端问题。另外所谓多态在实际开发中会造成大量冗余代码,很不利于复用和维护。举例,微信小程序主题色是绿色,而百度支付宝小程序是蓝色,你的应用想分平台适配颜色,只有条件编译是代码量最低、最容易维护的。
  • 有些公司的产品运营总是给不同平台提不同需求,但这不是拒绝uni-app的理由。关键在于项目里,复用的代码多还是个性的代码多,正常都是复用的代码多,所以仍然应该多端。而个性的代码放到不同平台的目录下,差异化维护。

环境变量

uni-app 项目中配置环境变量主要有如下三种方式

vue-config.js

在 vue.config.js 中可以修改 webpack 配置,包括环境变量,具体参考 vue-config.js (opens new window)

package.json

在自定义条件编译平台时,可以在 package.json 文件的 env 节点下配置环境变量,具体参考 package.json (opens new window)

编译器配置

你可以通过如下入口,对uni-app编译器进行配置:

manifest.json

在manifest.json中,你可以配置Vue的版本(Vue2/Vue3),以及发行H5平台路由模式,详见: manifest.json (opens new window)

vue.config.js

在 vue.config.js 中可以修改 webpack 配置,包括环境变量,具体参考 vue-config.js (opens new window)

vite.config.js

在 vite.config.js 中可以修改 Vite 配置,包括环境变量,具体参考 vite.config.js (opens new window)

package.json

在自定义条件编译平台时,可以在 package.json 文件的 env 节点下配置环境变量,具体参考 package.json (opens new window)

.env

CLI 创建的项目中可以在根目录中放置 .env 文件来指定环境变量,具体参考:[环境变量](https://cli.vuejs.org/zh/guide/mode-and-env.html#环境变量

13 web专题

宽屏适配指南

uni-app是以移动为先的理念诞生的。从uni-app 2.9起,提供了PC等宽屏的适配方案,完成了全端统一。

PC适配和屏幕适配略有差异。PC适配包含宽屏适配uni-app内置组件适配PC两方面的工作。

uni- app内置组件的PC适配,又包括PC交互习惯的UI调整非webkit浏览器适配这两部分。这块工作不在本文的讨论范围内,尤其是开发者在PC端可以随意使用普通html元素和组件,不局限于uni- app内置组件。所以本文重点讨论屏幕适配。

uni-app提供的屏幕适配方案,包括3部分:

1. 页面窗体级适配方案:leftWindow、rightWindow、topWindow

以目前手机屏幕为主window,在左右上,可新扩展 leftWindow、rightWindow、topWindow,这些区域可设定在一定屏幕宽度范围自动出现或消失。这些区域各自独立,切换页面支持在各自的window内刷新,而不是整屏刷新。

各个window之间可以交互通信。

这里有2个例子:

  • hello uni-app:https://hellouniapp.dcloud.net.cn/
  • 分栏式的新闻模板:https://static-1fdf8972-67c0-42b4-8790-2021eb9134d1.bspapp.com/#/,这个示例对应的源码在:https://github.com/dcloudio/uni-template-news

新闻示例项目,预览地址https://static-7d133019-9a7e-474a-b7c2-c01751f00ca5.bspapp.com/#/显示The requested file was not found on this server.

以上示例建议使用最新版的chrome、Safari、或firefox访问。可以在PC模式和手机模式分别体验。以上示例源码的运行需使用HBuilderX 2.9+

这些例子特点如下:

  • hello uni-app使用了topWindow和leftWindow,分为上左右3栏。新闻模板使用了rightWindow区域,分为左右2栏。宽屏下点击左边的列表在右边显示详情内容。而窄屏下仍然是点击列表后新开一个页面显示详情内容。
  • leftWindow或rightWindow 里的页面是复用的,不需要重写新闻详情页面,支持把已有详情页面当组件放到 leftWindow或rightWindow 页面中。

这套方案是已知的、最便捷的分栏式宽屏应用适配方案。

H5 宽屏下 tabBar(选项卡) 的显示与隐藏

如果在 PC 上不想显示 tabbar 页面可以参考 hello-uniapp,在 app 的首页加载时跳转一个 非tabbar 页, hello- uniapp (opens new window) 的隐藏 tabbar 不是媒体查询实现的,当前页不是 tabbar 页面(是pages/component/view/view页),所以没有显示tabbar。

如果是想在有 leftwindow 等窗体的时候,隐藏 tabar 页面的 tabbar,可以用 css 实现(好处是可以和leftwindow等窗体联动):

      .uni-app--showleftwindow + .uni-tabbar-bottom {
      	display: none;
      }

leftWindow等配置,在pages.json里进行。文档见:https://uniapp.dcloud.net.cn/collocation/pages?id=topwindow

pages.json 配置样例

    {
      "globalStyle": {
        
      },
      "topWindow": {
        "path": "responsive/top-window.vue", // 指定 topWindow 页面文件
        "style": {
          "height": "44px"
        }
      },
      "leftWindow": {
        "path": "responsive/left-window.vue", // 指定 leftWindow 页面文件
        "style": {
          "width": 300
        }
      },
      "rightWindow": {
        "path": "responsive/right-window.vue", // 指定 rightWindow 页面文件
        "style": {
          "width": "calc(100vw - 400px)" // 页面宽度
        },
        "matchMedia": {
          "minWidth": 768 //生效条件,当窗口宽度大于768px时显示
        }
      }
    }
  • leftWindow等方案的使用教程

如果已经有了一个为小屏设计的uni-app,在使用leftWindow等窗体适配大屏时,需理清一个思路:现有的小屏内容,放在哪个window里?

如果应用的首页是列表,二级页是详情,此时适合的做法是,将原有的小屏列表作为主window,在右边扩展rightWindow来显示详情。

以新闻示例项目为例,预览地址https://static-1fdf8972-67c0-42b4-8790-2021eb9134d1.bspapp.com/#/。这个项目的源码已经内置于HBuilderX 2.9中,新建uni-app项目时选择新闻/资讯模板。

首先在这个项目的pages.json文件中,配置rightWindow选项 (opens new window),放置一个新页面right- window.vue

    # pages.json
    "rightWindow": {
        "path": "responsive/right-window.vue",
        "style": {
          "width": "calc(100vw - 450px)"
        },
        "matchMedia": {
          "minWidth": 768
        }
      }

rightWindow对应的页面不需要重写一遍新闻详情的页面逻辑,只需要引入之前的详情页面组件(详情页面/pages/detail/detail可自动转化为pages- detail-detail组件使用)。

    <!--responsive/right-window.vue-->
    <template>
      <view>
        <!-- 这里将 /pages/detail/detail.nvue 页面作为一个组件使用 -->
        <!-- 路径 “/pages/detail/detail” 转为 “pages-detail-detail” 组件 -->
        <pages-detail-detail ref="detailPage"></pages-detail-detail>
      </view>
    </template>
    
    <script>
      export default {
        created(e) {
          //监听自定义事件,该事件由详情页列表的点击触发
          uni.$on('updateDetail', (e) => {
            // 执行 detailPage组件,即:/pages/detail/detail.nvue 页面的load方法
            this.$refs.detailPage.load(e.detail);
          })
        },
        onLoad() {},
        methods: {}
      }
    </script>

然后在新闻列表页面,处理点击列表后与rightWindow交互通信的逻辑。

    // pages/news/news-page.nvue
    goDetail(detail) {
    	if (this._isWidescreen) { //若为宽屏,则触发右侧详情页的自定义事件,通知右侧窗体刷新新闻详情
    		uni.$emit('updateDetail', {
    			detail: encodeURIComponent(JSON.stringify(detail))
    		})
    	} else { // 若为窄屏,则打开新窗体,在新窗体打开详情页面
    		uni.navigateTo({
    			url: '/pages/detail/detail?query=' + encodeURIComponent(JSON.stringify(detail))
    		});
    	}
    },

可以看到,无需太多工作量,就可以快速把一个为手机窄屏开发的应用,快速适配为PC宽屏应用。并且以后的代码维护,仍然是同一套,当业务迭代时不需要多处升级。

rightWindow适用于分栏式应用,那leftWindow一般用于什么场景?

leftWindow比较适合放置导航页面。如果你的应用首页有很多tab和宫格导航,那么可以把它们重组,放在leftWindow作为导航。之前在手机竖屏上依靠多级tab和宫格导航的场景,可以在leftWindow里通过tree或折叠面板方式导航。

leftWindow除了适用于手机应用适配大屏,也适用于重新开发的PC应用,尤其是PC Admin管理控制台。

DCloud官方基于uni-app的pc版,推出了unicloud Admin:https://uniapp.dcloud.net.cn/uniCloud/admin

目前的leftWindow、rightWindow、topWindow 只支持web端。计划后续在Pad App上实现该配置。小程序无法支持该配置。

2. 组件级适配方案:match-media组件

leftWindow等方案是页面窗体级适配方案。适于独立的页面。那么在同一个页面中,是否可以适配不同屏宽?当然可以,此时可以使用组件级适配方案。

uni-app提供了 match-media组件 (opens new window) 和配套的 uni.createMediaQueryObserver (opens new window) 方法。

这是一个媒体查询适配组件,可以更简单的用于动态屏幕适配。

match-media组件中放置内容,并为组件指定一组 media query 媒体查询规则,如屏幕宽度。运行时,如屏幕宽度满足查询条件,这个组件就会被展示,反之则隐藏。

match-media组件的优势包括:

  1. 开发者能够更方便、显式地使用 Media Query 能力,而不是耦合在 CSS 文件中,难以复用。
  2. 能够在模板中结合数据绑定动态地使用,不仅能做到组件的显示或隐藏,在过程式 API 中可塑性更高,例如能够根据尺寸变化动态地添加 class 类名,改变样式。
  3. 能够嵌套式地使用 Media Query 组件,即能够满足局部组件布局样式的改变。
  4. 组件化之后,封装性更强,能够隔离样式、模版以及绑定在模版上的交互事件,还能够提供更高的可复用性。

它的详细文档参考:https://uniapp.dcloud.net.cn/component/match-media

当然,开发者也可以继续使用css媒体查询来适配屏幕,或者使用一些类似mobilehide、pcshow之类的css样式。

uni- app的屏幕适配推荐方案是运行时动态适配,而不是为PC版单独条件编译(虽然您也可以通过自定义条件编译来实现单独的PC版)。这样设计的好处是在ipad等设备的浏览器上可以方便的横竖屏切换。

3. 内容缩放拉伸的处理

除了根据屏宽动态显示和隐藏内容,其实还有一大类屏幕适配需求,即:内容不会根据屏宽动态显示隐藏,而是缩放或拉伸。

具体来说,内容适应又有两种细分策略:

  1. 局部拉伸:页面内容划分为固定区域和长宽动态适配区域,固定区域使用固定的px单位约定宽高,长宽适配区域则使用flex自动适配。当屏幕大小变化时,固定区域不变,而长宽适配区域跟着变化
  2. 等比缩放:根据页面屏幕宽度缩放。rpx其实属于这种类型。在宽屏上,rpx变大,窄屏上rpx变小。

举个实际的例子,比如一个列表页面,左边有一个图标,右边是2行文字。

  • 如果使用策略1,即局部拉伸,那么左边的图标部分固定一个宽高,右边的2行文字的大小也固定,但2行文字的宽度自适应,占满屏幕右侧的空间。也就是屏宽宽度变化后,只有2行文字的宽度在变化,其他一切不变。
  • 如果使用策略2,即等比缩放,那么整个列表均使用rpx,在宽屏上,图标变大、右边的2行文字变大,列表项行高变大。而在窄屏上,一切又都变小。

策略2省事,设计师按750px屏宽出图,程序员直接按rpx写代码即可。但策略2的实际效果不如策略1好。程序员使用策略1,分析下界面,设定好局部拉伸区域,这样可以有更好的用户体验。

这里需要对rpx的使用特别强调一下。

在移动设备上也有很多屏幕宽度,设计师一般只会按照750px屏幕宽度出图。此时使用rpx的好处在于,各种移动设备的屏幕宽度差异不是很大,相对于750px微调缩放后的效果,尽可能的还原了设计师的设计。

但是,一旦脱离移动设备,在pc屏幕,或者pad横屏状态下,因为屏幕宽度远大于750了。此时rpx根据屏幕宽度变化的结果就严重脱离了预期,大的惨不忍睹。

为此,在uni-app 2.9+起,新增了 rpx 按750px做基准屏宽的生效范围控制,并且将 rpx 的默认最大适配宽度设为了 960 px。

也就是设计师按750px出具的设计图,可适配的最大屏幕宽度为960px,在这个范围内,rpx可以根据屏幕宽度缩放。一旦超过960,rpx再根据屏幕宽度缩放就变的没有意义了。按如下配置,在超过960宽的屏幕上,会按375px作为基准宽度,这是最大程度上保持界面不失真的策略。

当然这些配置您都可以自己定义调整,在 pages.json 的 globeStyle 里配置 rpx 的如下参数。

    {
      "globalStyle": {
        "rpxCalcMaxDeviceWidth": 960, // rpx 计算所支持的最大设备宽度,单位 px,默认值为 960
        "rpxCalcBaseDeviceWidth": 375, // rpx 计算使用的基准设备宽度,设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算,单位 px,默认值为 375
        "rpxCalcIncludeWidth": 750 // rpx 计算特殊处理的值,始终按实际的设备宽度计算,单位 rpx,默认值为 750
      },
    }

通过上述配置中的前2个,即rpxCalcMaxDeviceWidth和rpxCalcBaseDeviceWidth,即可有效解决使用了rpx后,在宽屏下界面变的奇大无比的问题。如果你不需要特别定义这2个参数的数值,则无需在pages.json中配置它们,保持默认的960和375即可。

但是,rpx的最大适配宽度被限定后,会带来一个新问题:如果您的代码中把750rpx当做100%来使用(官方强烈不推荐这种写法,即便是nvue不支持百分比,也应该使用flex来解决撑满问题),此时不管屏幕宽度为多少,哪怕超过了960px,您的预期仍然是要占满整个屏幕宽度,但如果按rpxCalcBaseDeviceWidth的375px的策略执行将不再占满屏宽。

此时您有两种解决方案,一种是修改代码,将里面把rpx当做百分比的代码改掉;另一种是配置rpxCalcIncludeWidth,设置某个特定数值不受rpxCalcMaxDeviceWidth约束。如上述例子中的"rpxCalcIncludeWidth": 750,代表着如果写了 750rpx,始终将按屏幕宽度百分百占满来计算。

  • 关于 rpx 转 px

不少开发者之前对rpx的使用过于没有节制,后来为了适配宽屏,想要改用“局部拉伸:页面内容划分为固定区域和长宽动态适配区域”的策略,此时将回归px。

比如DCloud社区的宽屏适配示例 (opens new window)新闻模板 (opens new window)都没有使用rpx。

如果想把rpx转px,可以在源码里正则替换,也可以使用三方已经写好的单位转换库。下面介绍下三方库的用法。

项目根目录新增文件 postcss.config.js,内容如下。则在编译时,编译器会自动转换rpx单位为px。

注意:将rpx作为百分比的用法需要手动处理

    // postcss.config.js
    
    const path = require('path')
    module.exports = {
      parser: 'postcss-comment',
      plugins: {
        'postcss-import': {
          resolve(id, basedir, importOptions) {
            if (id.startsWith('~@/')) {
              return path.resolve(process.env.UNI_INPUT_DIR, id.substr(3))
            } else if (id.startsWith('@/')) {
              return path.resolve(process.env.UNI_INPUT_DIR, id.substr(2))
            } else if (id.startsWith('/') && !id.startsWith('//')) {
              return path.resolve(process.env.UNI_INPUT_DIR, id.substr(1))
            }
            return id
          }
        },
        'autoprefixer': {
          overrideBrowserslist: ["Android >= 4", "ios >= 8"],
          remove: process.env.UNI_PLATFORM !== 'h5'
        },
        // 借助postcss-px-to-viewport插件,实现rpx转px,文档:https://github.com/evrone/postcss-px-to-viewport/blob/master/README_CN.md
        // 以下配置,可以将rpx转换为1/2的px,如20rpx=10px,如果要调整比例,可以调整 viewportWidth 来实现
        'postcss-px-to-viewport': {
          unitToConvert: 'rpx',
          viewportWidth: 200,
          unitPrecision: 5,
          propList: ['*'],
          viewportUnit: 'px',
          fontViewportUnit: 'px',
          selectorBlackList: [],
          minPixelValue: 1,
          mediaQuery: false,
          replace: true,
          exclude: undefined,
          include: undefined,
          landscape: false
        },
        '@dcloudio/vue-cli-plugin-uni/packages/postcss': {}
      }
    }

非webkit浏览器适配

uni-app理论上不限定浏览器。在HBuilderX 2.9发版时,就新闻示例项目,在chrome、Safari、firefox、edge的最新版上均测试过,可以正常使用。

一般国内的浏览器,如360浏览器、搜狗浏览器,均支持chrome内核,只要版本够新,应该都可以访问。

如果你的应用在其他PC浏览器下异常,请检查自己代码的浏览器兼容问题。

如果你发现了uni-app框架层面、内置组件有浏览器兼容问题,欢迎在github上给我们提交pr。

一般情况下,只要基础框架没有浏览器兼容问题,那么组件层面的问题也可以通过更换组件来解决。当uni- app编译到PC浏览器端时,支持所有的vue组件,包含那些操作了dom、window的ui库,比如elementUI等。

一个让手机版网页临时可用于pc浏览器的方案

如果你的h5版已经开发完毕,还没来得及适配pc,但想在pc上先用起来。那么可以在pc网页里使用iframe,约定好宽度,在里面套用uni-app的窄屏版。

当然还可以在iframe旁边放置二维码,提供手机版扫码地址,例如:

通过electron打包为windows、mac、linux客户端

有了宽屏适配,uni-app的应用就可以方便的通过electron打包为电脑客户端应用,windows、mac、linux均支持。

开发者可以随意调用electron的API,以调用更多操作系统的能力(为方便多端兼容,可以将这些特殊API写在自定义的条件编译里)

插件市场有已经封装好的一些插件,详见:https://ext.dcloud.net.cn/search?q=electron

响应式布局组件:uni-row

流式栅格系统,随着屏幕或视口分为 24 份,可以迅速简便地创建布局。

该插件将屏幕分为五个档位:<768px>=768px>=992px>=1200px>=1920px

对应的可以使用xssmmdlgxl来控制在不同分辨率下的显示效果。详情可在插件市场查看。

插件地址:https://ext.dcloud.net.cn/plugin?id=3958

14 App相关

nvue原生渲染

概述

uni-app App 端内置了一个基于 weex 改进的原生渲染引擎,提供了原生渲染能力。

在 App 端,如果使用 vue 页面,则使用 webview 渲染;如果使用 nvue 页面(native vue 的缩写),则使用原生渲染。一个 App 中可以同时使用两种页面,比如首页使用 nvue,二级页使用 vue 页面,hello uni-app 示例就是如此。

虽然 nvue 也可以多端编译,输出 H5 和小程序,但 nvue 的 css 写法受限,所以如果你不开发 App,那么不需要使用 nvue。

以往的 weex ,有个很大的问题是它只是一个高性能的渲染器,没有足够的 API 能力(比如各种 push sdk 集成、蓝牙等能力调用),使得开发时非常依赖原生工程师协作,开发者本来想节约成本,结果需要前端、iOS、Android 3 拨人开发,适得其反。 nvue 解决了这个问题,让前端工程师可以直接开发完整 App,并提供丰富的插件生态和云打包。这些组合方案,帮助开发者切实的提高效率、降低成本。

同时uni-app扩展了 weex 原生渲染引擎的很多排版能力,修复了很多 bug。比如

适用场景

nvue 的组件和 API 写法与 vue 页面一致,其内置组件还比 vue 页面内置组件增加了更多,详见 (opens new window)

如果你熟悉 weex 或 react native 开发,那么 nvue 是你的更优选择,能切实提升你的开发效率,降低成本。

如果你是 web 前端,不熟悉原生排版,那么建议你仍然以使用 vue 页面为主,在 App 端某些 vue 页面表现不佳的场景下使用 nvue 作为强化补充。这些场景如下:

  1. 需要高性能的区域长列表或瀑布流滚动。webview 的页面级长列表滚动是没有性能问题的(就是滚动条覆盖 webview 整体高度),但页面中某个区域做长列表滚动,则需要使用 nvue 的listrecycle-listwaterfall等组件(详见 (opens new window))。这些组件的性能要高于 vue 页面里的区域滚动组件scroll-view
  2. 复杂高性能的自定义下拉刷新。uni-app 的 pages.json 里可以配置原生下拉刷新,但引擎内置的下拉刷新样式只有雪花和 circle 圈 2 种样式。如果你需要自己做复杂的下拉刷新,推荐使用 nvue 的 refresh 组件。当然插件市场 (opens new window)里也有很多 vue 下的自定义下拉刷新插件,只要是基于 renderjs 或 wxs 的,性能也可以商用,只是没有 nvue 的refresh组件更极致。
  3. 左右拖动的长列表。在 webview 里,通过swiper+scroll-view实现左右拖动的长列表,前端模拟下拉刷新,这套方案的性能不好。此时推荐使用 nvue,比如新建 uni-app 项目时的新闻示例模板 (opens new window),就采用了 nvue,切换很流畅。
  4. 实现区域滚动长列表+左右拖动列表+吸顶的复杂排版效果,效果可参考 hello uni-app 模板里的swiper-list详见 (opens new window)
  5. 如需要将软键盘右下角按钮文字改为“发送”,则需要使用 nvue。比如聊天场景,除了软键盘右下角的按钮文字处理外,还涉及聊天记录区域长列表滚动,适合 nvue 来做。
  6. 解决前端控件无法覆盖原生控件的层级问题。当你使用mapvideolive-pusher等原生组件时,会发现前端写的view等组件无法覆盖原生组件,层级问题处理比较麻烦,此时使用 nvue 更好。或者在 vue 页面上也可以覆盖一个 subnvue(一种非全屏的 nvue 页面覆盖在 webview 上),以解决 App 上的原生控件层级问题。详见 (opens new window)
  7. 如深度使用map组件,建议使用 nvue。除了层级问题,App 端 nvue 文件的 map 功能更完善,和小程序拉齐度更高,多端一致性更好。
  8. 如深度使用video,建议使用 nvue。比如如下 2 个场景:video 内嵌到 swiper 中,以实现抖音式视频滑动切换,例子见插件市场 (opens new window);nvue 的视频全屏后,通过cover-view实现内容覆盖,比如增加文字标题、分享按钮。
  9. 直播推流:nvue 下有live-pusher组件,和小程序对齐,功能更完善,也没有层级问题。
  10. 对 App 启动速度要求极致化。App 端如果首页使用 nvue 且在 manifest 里配置 fast 模式,那么 App 的启动速度可以控制在 1 秒左右。而使用 vue 页面的话,App 的启动速度一般是 3 秒起,取决于你的代码性能和体积。

但注意,在某些场景下,nvue 不如 vue 页面,如下:

  1. canvas。nvue 的 canvas 性能不高,尤其是 Android App 平台,所以这个组件干脆没有内置,而是需要单独引入。操作 canvas 动画,最高性能的方式是使用 vue 页面的 renderjs 技术,在 hello uni-app 里的 canvas 示例就是如此。
  2. 动态横竖屏。nvue 页面的 css 不支持媒体查询,所以横竖屏动态切换、动态适配屏幕是很困难的
纯原生渲染模式

uni-app 在 App 端,支持 vue 页面和 nvue 页面混搭、互相跳转。也支持纯 nvue 原生渲染。

启用纯原生渲染模式,可以减少 App 端的包体积、减少使用时的内存占用。因为 webview 渲染模式的相关模块将被移除。

在 manifest.json 源码视图的"app-plus"下配置"renderer":"native",即代表 App 端启用纯原生渲染模式。此时 pages.json 注册的 vue 页面将被忽略,vue 组件也将被原生渲染引擎来渲染。

如果不指定该值,默认是不启动纯原生渲染的。

    	// manifest.json
    	{
    	   // ...
    		// App平台特有配置
    	   "app-plus": {
    	      "renderer": "native", //App端纯原生渲染模式
    	   }
    	}
编译模式

weex 编译模式和 uni-app 编译模式

如你之前是 weex 开发者,可以继续查阅本章节,否则可以跳过看下一节[快速上手 (opens new window)](https://uniapp.dcloud.net.cn/tutorial/nvue- outline.html#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B)。

weex 的组件和 JS API,与 uni-app 不同。uni-app 与微信小程序相同。

考虑到 weex 用户的迁移,uni-app 也支持 weex 的代码写法。在 manifest.json 中可以配置使用weex 编译模式uni-app 编译模式 。选择 weex 编译模式时将不支持 uni-app 的组件和 jsapi,需要开发者参考 weex 官方文档的写法来写代码。 比如 weex 编译模式用<div>。uni-app 编译模式则使用<view>

一般情况建议使用uni-app模式,除非历史 weex 代码较多,需要逐步过渡。同时注意 weex 编译模式的切换是项目级的,不支持同项目下某个 nvue 页面使用 weex 模式,另一个 nvue 页面使用 uni-app 模式。

weex 编译模式 | uni-app 编译模式 |
---|---|---
平台 | 仅 App | 所有端,包含小程序和 H5
组件 | weex 组件如 div | uni-app 组件如 view
生命周期 | 只支持 weex 生命周期 | 支持所有 uni-app 生命周期
JS API | weex API、uni API、Plus API | weex API、uni API、Plus API
单位 | 750px 是屏幕宽度,wx 是固定像素单位 | 750rpx 是屏幕宽度,px 是固定像素单位
全局样式 | 手动引入 | app.vue 的样式即为全局样式
页面滚动 | 必须给页面套或组件 | 默认支持页面滚动

在 manifest.json 中修改 2 种编译模式,manifest.json -> app-plus -> nvueCompiler 切换编译模式。

nvueCompiler 有两个值:

  • weex
  • uni-app
    	// manifest.json
    	{
    		// ...
    		// App平台特有配置
    		"app-plus": {
    			"nvueCompiler":"uni-app" //是否启用 uni-app 模式
    		}
    	}

manifest.json 配置文件中,HBuilderX2.4 之前版本,默认值为 weex 模式,HBuilderX2.4+版本默认值改为 uni-app 模式。

weex 编译模式不支持 onNavigationBarButtonTap 生命周期函数的写法。在 nvue 中监听原生标题栏按钮点击事件,详见:uni.onNavigationBarButtonTap (opens new window)

weex 编译模式不支持 onShow 生命周期,但熟悉 5+的话,可利用监听 webview 的addEventListener show 事件实现 onShow 效果。

weex 编译模式不支持vuex

nvue 的页面跳转,与 weex 不同,仍然遵循 uni-app 的路由模型。vue 页面和 nvue 页面之间不管怎么跳转,都遵循这个模型。包括 nvue 页面跳向 nvue 页面。每个页面都需要在 pages.json 中注册,调用 uni-app 的 路由 API (opens new window) 进行跳转。

原生开发没有页面滚动的概念,页面内容高过屏幕高度时,内容并不会自动滚动;只有将页面内容放在listwaterfallscroll- view/scroller这几个组件下内容才可滚动。这不符合前端开发的习惯,所以在 nvue 编译为 uni-app模式时,uni-app框架会给 nvue 页面外层自动嵌套一个 scroller,从而实现页面内容的自动滚动。

注意:

  • uni-app框架仅对 nvue 页面嵌套scroller容器,不会给组件自动套scroller容器;
  • 若 nvue 页面有recycle-list组件时,uni-app框架也不会自动给页面嵌套scroller容器
  • 若你不希望自动嵌套scroller容器,可在pages.json中通过如下配置进行关闭:
    {
        "path": "",
        "style": {
            "disableScroll": true // 不嵌套 scroller
        }
    }

weex 编译模式下支持使用 weex ui ,例子详见 (opens new window)。但相比 uni-app 插件市场及官方uni ui (opens new window)而言,weex 语法的组件生态还是比较欠缺的。

HBuilderX 3.1.0+ 开始支持新的样式编译模式

  • weex 编译模式:老模式,样式支持与普通 weex 相同
  • uni-app 编译模式:新模式,在 weex 原有样式基础上支持组合选择器(相邻兄弟选择器、普通兄弟选择器、子选择器、后代选择器)详见 (opens new window)
      // manifest.json
      {
          // ...
          // App平台特有配置
          "app-plus":  {
              "nvueStyleCompiler": "uni-app"
          }
      }
快速上手

1.新建 nvue 页面

在 HBuilderX 的 uni-app 项目中,新建页面,弹出界面右上角可以选择是建立vue页面还是nvue页面,或者 2 个同时建。

不管是 vue 页面还是 nvue 页面,都需要在pages.json中注册。如果在 HBuilderX 中新建页面是会自动注册的,如果使用其他编辑器,则需要自行在 pages.json 里注册。

如果一个页面路由下同时有 vue 页面和 nvue 页面,即出现同名的 vue 和 nvue 文件。那么在 App 端,会仅使用 nvue 页面,同名的 vue 文件将不会被编译到 App 端。而在非 App 端,会优先使用 vue 页面。

如果不同名,只有 nvue 页面,则在非 app 端,只有 uni-app 编译模式的 nvue 文件才会编译

2.开发 nvue 页面

nvue 页面结构同 vue, 由 templatestylescript 构成。

  • template: 模板写法、数据绑定同 vue。组件支持 2 种模式,
    • weex 组件,同 weex 写法,参考:weex 内置组件 (opens new window)
    • uni-app 组件,同 uni-app 写法。
    • App 端 nvue 专用组件,详见https://uniapp.dcloud.io/component/barcode。
  • style:由于采用原生渲染,并非所有浏览器的 css 均支持,布局模型只支持 flex 布局 ,虽然不会造成某些界面布局无法实现,但写法要注意。详见:样式 (opens new window)
  • script:写法同 vue,并支持 3 种 API:
    • nvue API :仅支持 App 端,uni-app 编译模式也可使用。使用前需先引入对应模块,参考:模块引入 API (opens new window)
    • uni API:https://uniapp.dcloud.io/api/README
    • plus API:仅支持 App 端。http://www.html5plus.org/doc/h5p.html

3. 调试 nvue 页面

HBuilderX 内置了 weex 调试工具的强化版,包括审查界面元素、看 log、debug 打断点,详见 (opens new window)

nvue开发与vue开发的常见区别

基于原生引擎的渲染,虽然还是前端技术栈,但和web开发肯定是有区别的。

  1. nvue 页面控制显隐只可以使用v-if不可以使用v-show
  2. nvue 页面只能使用flex布局,不支持其他布局方式。页面开发前,首先想清楚这个页面的纵向内容有什么,哪些是要滚动的,然后每个纵向内容的横轴排布有什么,按 flex 布局设计好界面。
  3. nvue 页面的布局排列方向默认为竖排(column),如需改变布局方向,可以在 manifest.json -> app-plus -> nvue -> flex-direction 节点下修改,仅在 uni-app 模式下生效。详情 (opens new window)
  4. nvue页面编译为H5、小程序时,会做一件css默认值对齐的工作。因为weex渲染引擎只支持flex,并且默认flex方向是垂直。而H5和小程序端,使用web渲染,默认不是flex,并且设置display:flex后,它的flex方向默认是水平而不是垂直的。所以nvue编译为H5、小程序时,会自动把页面默认布局设为flex、方向为垂直。当然开发者手动设置后会覆盖默认设置。
  5. 文字内容,必须、只能在<text>组件下。不能在<div><view>text区域里直接写文字。否则即使渲染了,也无法绑定js里的变量。
  6. 只有text标签可以设置字体大小,字体颜色。
  7. 布局不能使用百分比、没有媒体查询。
  8. nvue 切换横竖屏时可能导致样式出现问题,建议有 nvue 的页面锁定手机方向。
  9. 支持的css有限,不过并不影响布局出你需要的界面,flex还是非常强大的。详见 (opens new window)
  10. 不支持背景图。但可以使用image组件和层级来实现类似web中的背景效果。因为原生开发本身也没有web这种背景图概念
  11. css选择器支持的比较少,只能使用 class 选择器。详见 (opens new window)
  12. nvue 的各组件在安卓端默认是透明的,如果不设置background-color,可能会导致出现重影的问题。
  13. class 进行绑定时只支持数组语法。
  14. Android端在一个页面内使用大量圆角边框会造成性能问题,尤其是多个角的样式还不一样的话更耗费性能。应避免这类使用。
  15. nvue页面没有bounce回弹效果,只有几个列表组件有bounce效果,包括 listrecycle-listwaterfall
  16. 原生开发没有页面滚动的概念,页面内容高过屏幕高度并不会自动滚动,只有部分组件可滚动(listwaterfallscroll-view/scroller),要滚的内容需要套在可滚动组件下。这不符合前端开发的习惯,所以在 nvue 编译为 uni-app模式时,给页面外层自动套了一个 scroller,页面内容过高会自动滚动。(组件不会套,页面有recycle-list时也不会套)。后续会提供配置,可以设置不自动套。
  17. 在 App.vue 中定义的全局js变量不会在 nvue 页面生效。globalDatavuex是生效的。
  18. App.vue 中定义的全局css,对nvue和vue页面同时生效。如果全局css中有些css在nvue下不支持,编译时控制台会报警,建议把这些不支持的css包裹在条件编译 (opens new window)里,APP-PLUS-NVUE
  19. 不能在 style 中引入字体文件,nvue 中字体图标的使用参考:加载自定义字体 (opens new window)。如果是本地字体,可以用plus.io的API转换路径。
  20. 目前不支持在 nvue 页面使用 typescript/ts
  21. nvue 页面关闭原生导航栏时,想要模拟状态栏,可以参考文章 (opens new window)。但是,仍然强烈建议在nvue页面使用原生导航栏。nvue的渲染速度再快,也没有原生导航栏快。原生排版引擎解析json绘制原生导航栏耗时很少,而解析nvue的js绘制整个页面的耗时要大的多,尤其在新页面进入动画期间,对于复杂页面,没有原生导航栏会在动画期间产生整个屏幕的白屏或闪屏
iOS 平台下拉组件 refresh 组件注意问题

iOS 平台默认情况下滚动容器组件(如listwaterfall组件)内容不足时,由于没有撑满容器的可视区域会导致无法上下滚动,此时无法操作下拉刷新功能,无法触发refresh组件的@refresh@pullingdown事件。 此时可在容器组件中配置alwaysScrollableVertical属性值为true来设置支持上下滚动,支持下拉刷新操作。

用法

    <list class="scroll-v list" enableBackToTop="true" scroll-y alwaysScrollableVertical="true">
    	<refresh class="refresh" @refresh="onrefresh()" @pullingdown="onpullingdown">
    		<!-- refresh content -->
    	</refresh>
    	<cell v-for="(newsitem,index) in list" :key="newsitem.id">
    		<!-- cell content -->
    	</cell>
    </list>

Android 平台不存在此问题

样式

注意事项
  • nvue的css仅支持flex布局 ,是webview的css语法的子集。这是因为操作系统原生排版不支持非flex之外的web布局。当然flex足以排布出各种页面,只是写法需要适应。
  • class 进行绑定时只支持数组语法。
  • 不支持媒体查询
  • 不能在 style 中引入字体文件
  • 不能使用百分比布局,如width:100%
  • 不支持在css里写背景图background-image,但可以使用image组件和层级来实现类似web中的背景效果。因为原生开发本身也没有web这种背景图概念
  • 使用image标签,支持使用base64,不支持svg格式图片
  • nvue 的各组件在安卓端默认是透明的,如果不设置background-color,可能会导致出现重影的问题
  • 文字内容,必须只能在text组件下,text组件不能换行写内容,否则会出现无法去除的周边空白
  • 只有text标签可以设置字体大小,字体颜色
盒模型

nvue盒模型基于 CSS 盒模型,每个 nvue 元素都可视作一个盒子。我们一般在讨论设计或布局时,会提到「盒模型」这个概念。

盒模型描述了一个元素所占用的空间。每一个盒子有四条边界:外边距边界 margin edge, 边框边界 border edge, 内边距边界 padding edge 与内容边界 content edge。这四层边界,形成一层层的盒子包裹起来,这就是盒模型大体上的含义。

nvue盒模型的 box-sizing 默认为 border-box,即盒子的宽高包含内容、内边距和边框的宽度,不包含外边距的宽度。

在 Android 平台,nvue只支持 overflow:hidden

在 iOS 上,nvue支持 overflow:hiddenoverflow:visible,默认是 overflow:visible

Flexbox

flexbox 属性均不支持 :如 orderflex-growflex-shrinkflex- basisalign-contentalign-self

在 nvue中,Flexbox 是默认且唯一的布局模型,所以你不需要手动为元素添加display: flex; 属性。

Flex 成员项暂不支持flex-shrinkflex-basisalign-content 属性

该属性不支持 flex: flex-grow | flex-shrink | flex-basis 的简写

position 定位

Android 兼容性

如果定位元素超过容器边界,在 Android 下,超出部分将不可见,原因在于 Android 端元素 overflow 默认值为 hidden,但目前 Android 暂不支持设置 overflow: visible

伪类
参数名描述
active所有组件都支持
focus只有 input 组件和 textarea 组件支持
disabled只有 input 组件和 textarea 组件支持
enabled只有 input 组件和 textarea 组件支持

注意

同时生效的时候,优先级高覆盖优先级低。 例如:input:active:enabledinput:active 同时生效,前者覆盖后者

线性渐变

所有组件均支持线性渐变。CSS3 渐变 (opens new window) 你可以通过 background- image属性创建线性渐变。

    	background-image:linear-gradient(to bottom right,#AD18F9,#05DFC7);

只支持两种颜色的渐变,渐变方向如下:

渐变方向描述
to right从左向右渐变
to left从右向左渐变
to bottom从上到下渐变
to top从下到上渐变
to bottom right从左上角到右下角
to top left从右下角到左上角

注意

background-image 优先级高于 background-color,这意味着同时设置 background-imagebackground-colorbackground-color 被覆盖。 background 不支持简写。

目前暂不支持 radial-gradient(径向渐变)。

阴影box-shadow
  • Android平台 设置box-shadow的组件需要让出阴影渲染位置,否则会出现阴影显示不全的问题。
    <template>
    	<view class="wrapper">
    		<view>
    			<view class="box">
    				<text class="title" style="text-align: center">Hello World</text>
    			</view>
    		</view>
    	</view>
    </template>
    <style>
    	.box {
    		width: 300px;
    		height: 100px;
    		background-color: #FFE4C4;
    		border-radius: 10px;
    		box-shadow: 3px 5px 2px rgb(255, 69, 0);
    		margin: 10px;//让出阴影位置
    	}
    </style>
文本样式

color {color}:文字颜色,支持如下字段:

  • RGB( rgb(255, 0, 0) )
  • RGBA( rgba(255, 0, 0, 0.5) )
  • 十六进制( #ff0000 );
  • 精简写法的十六进制( #f00 )
  • 色值关键字(red)

只有text标签可以设置字体颜色

font-size

font-size {number}:文字大小,只有text标签可以设置字体大小

font-weight

font-weight {string}:字体粗细程度。默认值: normal

  • 可选值: normal, bold, 100, 200, 300, 400, 500, 600, 700, 800, 900
  • normal 等同于 400, bold 等同于 700;
  • iOS 支持 9 种 font-weight值;Android 仅支持 400 和 700, 其他值会设为 400 或 700
  • 类似 lighter, bolder 这样的值暂时不支持

text-overflow

text-overflow {string}:设置内容超长时的省略样式。

可选值描述
clip修剪文本
ellipsis显示省略符号来代表被修剪的文本

只支持 textrichtext

API

DOM

对于那些不依赖 UI 交互的原生功能,nvue将其封装成模块,这是一种通过 javascript 调用原生能力的方法。

  • uni-app默认内置集成原生模块,如:BindingX,animation, DOM.addRule等。 通过uni.requireNativePlugin引入 App 原生插件
    //使用方式
    	const PluginName = uni.requireNativePlugin(PluginName); // PluginName 为原生插件名称
  • 支持项目nativeplugins目录下和插件市场原生云打包的第三方原生插件。你可以将已有原生模块移植到nvue平台也很方便。 使用方式:在manifest.json->App原生插件配置->选择本地插件或者云端插件->打自定义基座才能使用。详见 (opens new window)
  • nvue还支持uni-app的js API接口,若无特殊说明,则表示vue文件和nvue文件均支持。详见 (opens new window)
  • nvue 里不支持的 uni-app API,详见 (opens new window)
addRule

Weex 提供 DOM.addRule 以加载自定义字体 。开发者可以通过指定 font-family加载 iconfont 和 custom font。开发者可以使用下面的代码加载自定义字体:

    	<template>
    		<view>
    			<text class="my-iconfont">&#xe85c;</text>	
    		</view>
    	</template>
    	<script>
    		export default{
    			beforeCreate() {
    				const domModule = uni.requireNativePlugin('dom')
    				domModule.addRule('fontFace', {
    					'fontFamily': "myIconfont",
    					'src': "url('http://at.alicdn.com/t/font_2234252_v3hj1klw6k9.ttf')"
    				});
    			}
    		}
    	</script>
    	<style>
    		.my-iconfont {
    			font-family:myIconfont;
    			font-size:60rpx;
    			color: #00AAFF;
    		}
    	</style>

addRule(type, contentObject)

  • @fontFace 协议名称,不可修改。
  • @fontFamily font-family的名称。
  • @src 字体地址,url('') 是保留字段,其参数如下:
    • http. 从HTTP请求加载, e.g. url('http://at.alicdn.com/t/font_1469606063_76593.ttf')
    • https. 从HTTPS请求加载, e.g. url('https://at.alicdn.com/t/font_1469606063_76593.ttf')
    • local, Android ONLY. 从assets目录读取, e.g. url('local://foo.ttf'), foo.ttf 是文件名在你的assets目录中.
    • file. 从本地文件读取, e.g. url('file://storage/emulated/0/Android/data/com.alibaba.weex/cache/http:__at.alicdn.com_t_font_1469606063_76593.ttf')
    • data. 从base64读取, e.g. url('data:font/truetype;charset=utf-8;base64,AAEAAAALAIAAAwAwR1NVQrD+....'), 上述data字段不全。

注意

addRule 方法里的 fontFamily 可以随意取。这个名字不是字体真正的名字。字体真正的名字(font- family),也就是注册到系统中的名字是保存在字体二进制文件中的。你需要确保你使用的字体的真正名字(font- family)足够特殊,否则在向系统注册时可能发生冲突,导致注册失败,你的字符被显示为‘?’。 如果你使用 http://www.iconfont.cn/ 来构建你的 iconfont。确保在项目设置中,设置一个特殊的 font-family 名字。默认是 “iconfont”,但极大可能发生冲突。 调用addRule 在 beforeCreate 中是被推荐的

scrollToElement

让页面滚动到 ref 对应的组件,这个 API 只能用于可滚动组件的子节点,例如 <scroller><list>, <waterfall> 等可滚动组件中。

scrollToElement(ref, options)

  • @ref,要滚动到的那个节点。
  • @options
    • offset,一个到其可见位置的偏移距离,默认是 0。
    • animated,是否需要附带滚动动画,默认是 true
     <template>
        <view class="wrapper">
          <scroller class="scroller">
            <view class="row" v-for="(name, index) in rows" :ref="'item'+index">
              <text class="text" :ref="'text'+index">{{name}}</text>
            </view>
          </scroller>
          <view class="group">
            <text @click="goto10" class="button">Go to 10</text>
            <text @click="goto20" class="button">Go to 20</text>
          </view>
        </view>
      </template>
      <script>
        const dom = uni.requireNativePlugin('dom')
        export default {
          data() {
            return {
              rows: []
            }
          },
          created() {
            for (let i = 0; i < 30; i++) {
              this.rows.push('row ' + i)
            }
          },
          methods: {
            goto10(count) {
              const el = this.$refs.item10[0]
              dom.scrollToElement(el, {})
            },
            goto20(count) {
              const el = this.$refs.item20[0]
              dom.scrollToElement(el, {
                offset: 0
              })
            }
          }
        }
      </script>
      <style scoped>
        .scroller {
          width:700rpx;
          height:500px;
          border-width: 3px;
          border-style: solid;
          border-color: rgb(162, 217, 192);
          margin:0 25rpx;
        }
        .row {
          height: 100rpx;
          flex-direction: column;
          justify-content: center;
          padding-left: 30rpx;
          border-bottom-width: 2px;
          border-bottom-style: solid;
          border-bottom-color: #DDDDDD;
        }
        .text {
          font-size: 45rpx;
          color: #666666;
        }
        .group {
          flex-direction: row;
          justify-content: center;
          margin-top: 60rpx;
        }
        .button {
          width: 200rpx;
          padding-top: 20rpx;
          padding-bottom: 20rpx;
          font-size: 40rpx;
          margin-left: 30rpx;
          margin-right: 30rpx;
          text-align: center;
          color: #41B883;
          border-width: 2px;
          border-style: solid;
          border-color: rgb(162, 217, 192);
          background-color: rgba(162, 217, 192, 0.2);
        }
      </style>

getComponentRect

获取某个元素 View 的外框。

getComponentRect(ref, callback)

  • @ref,要获取外框的那个节点。
  • @callback,异步方法,通过回调返回信息。

回调方法中的数据样例:

      {
        result: true,
        size: {
            bottom: 60,
            height: 15,
            left: 0,
            right: 353,
            top: 45,
            width: 353
        }
      }

此方法需要在节点渲染后调用才能获取正确的信息,可在 mounted 或 更新数据后 updated 中调用

如果想要获取到 Weex 视口容器的布局信息,可以指定 ref 为字符串 'viewport',即 getComponentRect('viewport', callback)

animation

animation模块可以用来在组件上执行动画。JS-Animation可以对组件执行一系列简单的变换 (位置、大小、旋转角度、背景颜色和不透明度)。

举个例子,如果有一个image组件,通过动画你可以对其进行移动、旋转、拉伸或收缩等动作。

      <template>
        <view class="box">
          <view ref="test" @click="move" class="box-item"></view>
        </view>
      </template>
      <script>
          const animation = uni.requireNativePlugin('animation')
          export default {
              methods: {
                  move() {
                      var testEl = this.$refs.test;
                      animation.transition(testEl, {
                          styles: {
                              backgroundColor: '#007AFF',
                              transform: 'translate(100px, 80px)',
                              transformOrigin: 'center center'
                          },
                          duration: 800, //ms
                          timingFunction: 'ease',
                          delay: 0 //ms
                      },()=>{
                          uni.showToast({
                              title: 'finished',
                              icon:'none'
                          });
                      })
                  }
              }
          }
      </script>
      <style scoped>
        .box{
            width:750rpx;
            height:750rpx;
        }
        .box-item{
          width: 250rpx;
          height: 250rpx;
          background-color: #00aaff;
        }
      </style>

transition
  • @ref,将要执行动画的元素。例如指定动画的元素 ref 属性为 test,可以通过调用 this.$refs.test 来获取元素的引用。
  • @options,动画参数。

下表列出了options所有合法的参数:

可选值描述
styles设置不同样式过渡效果的键值对
duration指定动画的持续时间 (单位是毫秒),默认值是 0,表示瞬间达到动画结束状态。
delay指定请求动画操作到执行动画之间的时间间隔 (单位是毫秒),默认值是 0,表示没有延迟,在请求后立即执行动画。
needLayout动画执行是否影响布局,默认值是false。
timingFunction描述动画执行的速度曲线,用于描述动画已消耗时间和动画完成进度间的映射关系。默认值是 linear,表示动画从开始到结束都拥有同样的速度。详见下

下表列出了styles所有合法的参数:

可选值描述
width表示动画执行后应用到组件上的宽度值。如果你需要影响布局,设置needLayout为true。默认值为computed width。
height表示动画执行后应用到组件上的高度值。如果你需要影响布局,设置设置为 needLayout为true。默认值为computed width。
backgroundColor动画执行后应用到组件上的背景颜色,默认值为computed backgroundColor。
opacity表示动画执行后应用到组件上的不透明度值,默认值为computed opacity。
transformOrigintransformOrigin 定义变化过程的中心点,如transformOrigin: x-axis y-axis 参数 x-axis 可能的值为 left、center、right、长度值或百分比值,参数 y-axis 可能的值为 top、center、bottom、长度值或百分比。默认值为center center。
transformtransform 变换类型,可能包含rotate,translate,scale及其他属性。默认值为空。详见下

transform

可选值描述
translate/translateX/translateY指定元素要移动到的位置。单位是长度或百分比,默认值是0.
rotate/rotateX/rotateYv0.16+ 指定元素将被旋转的角度。单位是度 角度度,默认值是0
scale/scaleX/scaleY按比例放大或缩小元素。单位是数字,默认值是1
perspectivev0.16+ 观察者距离z=0平面的距离,在Android 4.1及以上有效。单位值数字,默认值为正无穷。

timingFunction

可选值描述
linear动画从头到尾的速度是相同的
ease-in动画速度由慢到快
ease-out动画速度由快到慢
ease-in-out动画先加速到达中间点后减速到达终点
cubic-bezier(x1, y1, x2, y2)在三次贝塞尔函数中定义变化过程,函数的参数值必须处于 0 到 1 之间。更多关于三次贝塞尔的信息请参阅 cubic-bezier 和 Bézier curve。
  • @callback,callback是动画执行完毕之后的回调函数。在iOS平台上,你可以获取动画执行是否成功的信息。

注意

  • iOS上可以获取 animation 是否执行成功的信息,callback中的result参数会有两种,分别是是Success与Fail。
  • Android 的callback 函数不支持result参数。

如果需要使用CSS动画,参考[transition (opens new window)](https://uniapp.dcloud.net.cn/tutorial/nvue- css#transition)和transform (opens new window)

nvue 里使用 BindingX

uni-app 是逻辑层和视图层分离的。此时会产生两层通信成本。比如拖动视图层的元素,如果在逻辑层不停接收事件,因为通信损耗会产生不顺滑的体验。

BindingX (opens new window) 是weex提供的一种预描述交互语法。由原生解析BindingX规则,按此规则处理视图层的交互和动效。不再实时去js逻辑层运行和通信。

BindingX是一种规则,解析快,但没有js那样足够强的编程灵活性。

uni-app 内置了 BindingX,可在 nvue 中使用 BindingX 完成复杂的动画效果。

  • 从HBuilderX 2.3.4起,uni-app 编译模式可直接引用 uni.requireNativePlugin('bindingx') 模块,weex 模式还需使用 npm 方式引用。
  • BindingX demo示例可参考 BindingX 示例里 vue 的相关示例,将相关 vue 代码拷贝到 nvue 文件里即可。

注意

  • 暂时不要在 expression 内使用 origin
    <template>
    	    <view class="container">
    	        <view ref="b1" class=