mui入门教程

mui入门教程

资源索引

• Dcloud官网：http://dcloud.io/

• Dcloud问答社区：http://ask.dcloud.net.cn/

• Dcloud文档汇总地址：http://ask.dcloud.net.cn/docs/

• Hello mui线上演示地址：http://www.dcloud.io/hellomui...

 

 

• 官方入门文档(强烈推荐阅读):

  • DCloud产品概述

  • App入门开发

  • mui产品

  • 新手指南

• 案例汇总：http://dcloud.io/case/

• github地址：https://github.com/dcloudio/

• 开源项目地址：https://github.com/dcloudio/c...

官方分类文档

• html5+官网文档：http://www.html5plus.org/doc/

• mui文档：http://dev.dcloud.net.cn/mui/ui/

• 5+ App开发Native.js入门指南：http://ask.dcloud.net.cn/arti...

• Native.js示例汇总：http://ask.dcloud.net.cn/arti...

• 流应用开发指南：http://ask.dcloud.net.cn/arti...

 

html5+是什么？

html5+是DCloud提供的html5强化引擎，能够把HTML5 App打包为原生App，而且达到原生的功能和体验。说白了就是本来只能原生APP才能实现的功能，如今能够经过html5+这个强化引擎做为桥梁，你经过调用plus.*方法实现，也就是你能够经过书写js代码实现android和ios两套的原生功能。html5+封装了一些最经常使用的功能，并向W3C提交了做为标准的提案，具体的能够参考html5+规范API。

html5+和native.js有什么区别？

html5+做为一种通用标准，只封装了最经常使用的一些API，若是你有其余需求可是5+里面没有怎么办，这个时候若是你懂原生应用开发，你能够基于native.js语法规范进行个性化封装。Native.js for Android封装一条经过JS语法直接调用Native Java接口通道，经过plus.android可调用几乎全部的系统API。Native.js for iOS封装一条经过JS语法直接调用Native Objective-C接口通道，经过plus.ios可调用几乎全部的系统API。

5+ sdk是什么？

咱们常常看到html5+(即html5plus)、5+ sdk,其实本质是同样的，不过这里的5+ sdk是针对离线打包开发和Hybrid开发模式，由于用hbuilder在线打包，html5+和native.js的底层会被自动打包到安装包里面，开发者无需引用什么便可调用相关API。只要当开发者想要离线打包及Hybrid开发模式或者深刻了解html5+的引擎实现原理，才须要去了解一下5+ sdk，通常状况下咱们只须要知道5+标准里面的基本用法就足够咱们开发出一个APP。

mui与html5+有什么关系？

mui是Dcloud官方推出的一个基于html5+标准的框架，同时拥有h5组件和原生组件，原生组件依赖于html5+运行环境，也就是原生app里面的webview组件（能加载显示网页，能够将其视为一个浏览器），因此mui里面的原生组件不能用于浏览器环境，能够经过mui里面的mui.os.plus进行判断，若是是plus环境会返回true，不然会返回undefined。开发者能够根据本身的须要进行代码适配，对于APP使用加强的原生组件，对于普通浏览器里面运行的页面使用h5组件。同时用户还可使用mui.os.android、mui.os.ios及mui.os.wechat对平台进行检测，而后书写不一样的逻辑代码。对于mui里面没有封装的原生组件，你们能够根据本身的须要基于html5+标准和native.js语法进行个性化定制。所以这里咱们能够有一个基本影响就是咱们开始能够直接上手mui，不过须要明白mui与其余UI框架的区别在于，mui拥有独有的原生组件，并且这个是依赖于html5+标准的，因此mui里面的不少组件实现方法甚至用户就是html5+里面的标准写法，对html5+标准有必定了解有助于咱们理解mui的一些使用方法。

 

webview基本知识

 

Webview模块管理应用窗口界面，实现多窗口的逻辑控制管理操做。经过plus.webview可获取应用界面管理对象。

 

什么是窗口？什么是webview?

 

这里咱们首先来举个例子，你们都用过浏览器，经常使用的浏览器能够打开多个网页。电脑屏幕就是一个窗口，不一样的页面咱们能够什么是不一样的webview，咱们能够经过控制webview的切换从而控制浏览不一样的页面。

 

对于咱们这里就是一个html页面就是一个窗口，一个html页面能够建立多个webview。这个webview是原生APP中浏览网页的组件，android和iOS都有，html5plus中的webview是对原生webview的封装，能够用js进行调用，因此它的运行环境是APP环境，普通浏览器不支持。

 

首先咱们如今html5plus官网看一下webview API文档,这里咱们重点看一下下面几个方法:

 

建立新的Webview窗口

WebviewObject plus.webview.create( url, id, styles, extras );

说明：

建立Webview窗口，用于加载新的HTML页面，可经过styles设置Webview窗口的样式，建立完成后须要调用show方法才能将Webview窗口显示出来。

显示Webview窗口

plus.webview.show( id_wvobj, aniShow, duration, showedCB, extras );

说明：

显示已建立或隐藏的Webview窗口，需先获取窗口对象或窗口id，并可指定显示窗口的动画及动画持续时间。

隐藏Webview窗口

void plus.webview.hide( id_wvobj, aniHide, duration, extras );

说明：

根据指定的WebviewObject对象或id隐藏Webview窗口，使得窗口不可见。 

获取当前窗口的WebviewObject对象

WebviewObject plus.webview.currentWebview();

说明： 

获取当前页面所属的Webview窗口对象。

查找指定标识的WebviewObject窗口

WebviewObject plus.webview.getWebviewById( id );

说明：

在已建立的窗口列表中查找指定标识的Webview窗口并返回。 若没有查找到指定标识的窗口则返回null，若存在多个相同标识的Webview窗口，则返回第一个建立的Webview窗口。 若是要获取应用入口页面所属的Webview窗口，其标识为应用的%APPID%，可经过plus.runtime.appid获取。

建立并打开Webview窗口 

WebviewObject plus.webview.open( url, id, styles, aniShow, duration, showedCB );

说明：

建立并显示Webview窗口，用于加载新的HTML页面，可经过styles设置Webview窗口的样式，建立完成后自动将Webview窗口显示出来。 

 

以上来源于html5plus文档，只列举了部分最经常使用的方法，旨在为后文作铺垫，因为不是文档，因此也得也不清楚，若是想详细了解请看这里html5plus webview API。 

mui双webview模式

 

首先咱们要了解mui为了解决窗体切换白屏和区域滚动提出的双webview模式。

页面初始化

mui框架将不少功能配置都集中在mui.init方法中，要使用某项功能，只须要在mui.init方法中完成对应参数配置便可，目前支持在mui.init方法中配置的功能包括：建立子页面、关闭页面、手势事件配置、预加载、下拉刷新、上拉加载、设置系统状态栏背景颜色。mui须要在页面加载时初始化不少基础控件,如监听返回键,所以务必在每一个页面中调用.

如下是能够配置的参数：

mui.init({    //子页面    subpages: [{        //...    }],    //预加载    preloadPages:[        //...     ],    //下拉刷新、上拉加载     pullRefresh : {       //...    },    //手势配置      gestureConfig:{       //...    },    //侧滑关闭
    swipeBack:true, //Boolean(默认false)启用右滑关闭功能

    //监听Android手机的back、menu按键    keyEventBind: {
        backbutton: false,  //Boolean(默认truee)关闭back按键监听
        menubutton: false   //Boolean(默认true)关闭menu按键监听    },    //处理窗口关闭前的业务
    beforeback: function() {        //... //窗口关闭前处理其余业务详情点击 ↑ "关闭页面"连接查看    },    //设置状态栏颜色
    statusBarBackground: '#9defbcg', //设置状态栏颜色,仅iOS可用
    preloadLimit:5//预加载窗口数量限制(一旦超出,先进先出)默认不限制})

在app开发中，若要使用HTML5+扩展api，必须等plusready事件发生后才能正常使用，mui将该事件封装成了mui.plusReady()方法，涉及到HTML5+的api，建议都写在mui.plusReady方法中。

以下为打印当前页面URL的示例：

mui.plusReady(function(){
     console.log("当前页面URL："+plus.webview.currentWebview().getURL());
});

建立子页面

在mobile app开发过程当中，常常遇到卡头卡尾的页面，此时若使用局部滚动，在android手机上会出现滚动不流畅的问题； mui的解决思路是：将须要滚动的区域经过单独的webview实现，彻底使用原生滚动。具体作法则是：将目标页面分解为主页面和内容页面，主页面显示卡头卡尾区域，好比顶部导航、底部选项卡等；内容页面显示具体须要滚动的内容，而后在主页面中调用mui.init方法初始化内容页面。

mui.init({
    subpages:[{
      url:your-subpage-url,//子页面HTML地址，支持本地地址和网络地址
      id:your-subpage-id,//子页面标志      styles:{
        top:subpage-top-position,//子页面顶部位置
        bottom:subpage-bottom-position,//子页面底部位置
        width:subpage-width,//子页面宽度，默认为100%
        height:subpage-height,//子页面高度，默认为100%        ......
      },
      extras:{}//额外扩展参数    }]
  });

参数说明：

styles:表示窗口属性，参考5+规范中的WebviewStyle；特别注意，height和width两个属性,即便不设置，也默认按100%计算；所以若设置了top值为非"0px"的状况，建议同时设置bottom值，不然5+ runtime根据高度100%计算，可能会形成页面真实底部位置超出屏幕范围的状况；left、right同理。

ndex.html的做用就是显示固定导航，list.html显示具体列表内容，列表项的滚动是在list.html所在webview中使用原生滚动，既保证了滚动条不会穿透顶部导航，符合app的体验，也保证了列表流畅滚动，解决了区域滚动卡顿的问题。 list.html就是index.html的子页面，建立代码比较简单，以下：

mui.init({
    subpages:[{
      url:'list.html',
      id:'list.html',
      styles:{
        top:'45px',//mui标题栏默认高度为45px；
        bottom:'0px'//默认为0px，可不定义；      }
    }]
});

打开新页面

作web app，一个没法避开的问题就是转场动画；web是基于连接构建的，从一个页面点击连接跳转到另外一个页面，若是经过有刷新的打开方式，用户要面对一个空白的页面等待；若是经过无刷新的方式，用Javascript移入DOM节点（常见的SPA解决方案），会碰到很高的性能挑战：DOM节点繁多，页面太大，转场动画不流畅甚至致使浏览器崩溃； mui的解决思路是：单webview只承载单个页面的dom，减小dom层级及页面大小；页面切换使用原生动画，将最耗性能的部分交给原生实现。

mui.openWindow({
    url:new-page-url,
    id:new-page-id,
    styles:{
      top:newpage-top-position,//新页面顶部位置
      bottom:newage-bottom-position,//新页面底部位置
      width:newpage-width,//新页面宽度，默认为100%
      height:newpage-height,//新页面高度，默认为100%      ......
    },
    extras:{
      .....//自定义扩展参数，能够用来处理页面间传值    },
    createNew:false,//是否重复建立一样id的webview，默认为false:不重复建立，直接显示    show:{
      autoShow:true,//页面loaded事件发生后自动显示，默认为true
      aniShow:animationType,//页面显示动画，默认为”slide-in-right“；
      duration:animationTime//页面动画持续时间，Android平台默认100毫秒，iOS平台默认200毫秒；    },
    waiting:{
      autoShow:true,//自动显示等待框，默认为true
      title:'正在加载...',//等待对话框上显示的提示内容      options:{
        width:waiting-dialog-widht,//等待框背景区域宽度，默认根据内容自动计算合适宽度
        height:waiting-dialog-height,//等待框背景区域高度，默认根据内容自动计算合适高度        ......
      }
    }
})

参数说明：

• styles:表示窗口参数，参考5+规范中的WebviewStyle；特别注意，height和width两个属性,即便不设置，也默认按100%计算；所以若设置了top值为非"0px"的状况，建议同时设置bottom值，不然5+ runtime根据高度100%计算，可能会形成页面真实底部位置超出屏幕范围的状况,left、right同理。

• extras:新窗口的额外扩展参数，可用来处理页面间传值；例如：

var webview = mui.openWindow({
    url:'info.html',
    extras:{
        name:'mui'
    }
});
console.log(webview.name);

控制台会输出"mui"字符串；
注意：扩展参数仅在打开新窗口时有效，若目标窗口为预加载页面，则经过mui.openWindow方法打开时传递的extras参数无效。

• createNew:是否重复建立相同id的webview；为优化性能、避免app中重复建立webview，mui v1.7.0开始增长createNew参数，默认为false；判断逻辑以下：若createNew为true，则不判断重复，每次都新建webview；若为fasle，则先计算当前App中是否已存在一样id的webview，若存在则直接显示；不然新建立并根据show参数执行显示逻辑；该参数可能致使的影响：若业务写在plusReady事件中，而plusReady事件仅首次建立时会触发，则下次再次经过mui.openWindow方法打开一样webview时，是不会再次触发plusReady事件的，此时可经过自定义事件触发；案例参考：http://ask.dcloud.net.cn/question/6514;

• show:表示窗口显示控制。autoShow：目标窗口loaded事件发生后，是否自动显示；若目标页面为预加载页面，则该参数无效；aniShow表示页面显示动画，好比从右侧划入、从下侧划入等，具体可参考5+规范中的AnimationTypeShow。

• waiting:表示系统等待框；mui框架在打开新页面时等待框的处理逻辑为：显示等待框-->建立目标页面webview-->目标页面loaded事件发生-->关闭等待框；所以，只有当新页面为新建立页面（webview）时，会显示等待框，不然若为预加载好的页面，则直接显示目标页面，不会显示等待框。waiting中的参数：autoShow表示自动显示等待框，默认为true，若为false，则不显示等待框；注意：若显示了等待框，但目标页面不自动显示，则需在目标页面中经过以下代码关闭等待框plus.nativeUI.closeWaiting();。title表示等待框上的提示文字，options表示等待框显示参数，好比宽高、背景色、提示文字颜色等，具体可参考5+规范中的WaitingOption。

示例：从A页面打开B页面，B页面为一个须要从服务端加载的列表页面，若在B页面loaded事件发生时就将其显示出来，因服务器数据还没有加载完毕，列表页面为空，用户体验很差；可经过以下方式改善用户体验（最好的用户体验应该是经过预加载的方式）

第一步，B页面loaded事件发生后，不自动显示

//A页面中打开B页面，设置show的autoShow为false，则B页面在其loaded事件发生后，不会自动显示；mui.openWindow({
    url: 'B.html',
    show:{
      autoShow:false
    }
});

第二步，在B页面获取列表数据后，再关闭等待框、显示B页面

//B页面onload从服务器获取列表数据；window.onload = function(){  //从服务器获取数据  ....  //业务数据获取完毕，并已插入当前页面DOM；
  //注意：若为ajax请求，则需将以下代码放在处理完ajax响应数据以后；
  mui.plusReady(function(){    //关闭等待框    plus.nativeUI.closeWaiting();    //显示当前页面    mui.currentWebview.show();
  });
}

关闭页面

mui框架将窗口关闭功能封装在mui.back方法中，具体执行逻辑是：
若当前webview为预加载页面，则hide当前webview；不然，close当前webview。

在mui框架中，有三种操做会触发页面关闭（执行mui.back方法）。

• 点击包含.mui-action-back类的控件

• 在页面上，向右快速滑动

• Android手机按下back按键

hbuilder中敲mheader生成的代码块，会自动生成带有返回导航箭头的标题栏，点击返回箭头可关闭当前页面，缘由就是由于该返回箭头包含.mui-action-back类，代码以下：

<header class="mui-bar mui-bar-nav">
    <a class="mui-action-back mui-icon mui-icon-left-nav mui-pull-left"></a>
    <h1 class="mui-title">标题</h1>
</header>

若但愿在顶部导航栏以外的其它区域添加关闭页面的控件，只须要在对应控件上添加.mui-action-back类便可，以下为一个关闭按钮示例：

<button type="button" class='mui-btn mui-btn-danger mui-action-back'>关闭</button>

mui框架封装的页面右滑关闭功能，默认未启用，若要使用右滑关闭功能，须要在mui.init();方法中设置swipeBack参数，以下：

mui.init({
    swipeBack:true //启用右滑关闭功能});

mui框架默认会监听Android手机的back按键，而后执行页面关闭逻辑； 若不但愿mui自动处理back按键，可经过以下方式关闭mui的back按键监听；

mui.init({
    keyEventBind: {
        backbutton: false  //关闭back按键监听    }
});

除了如上三种操做外，也能够直接调用mui.back()方法，执行窗口关闭逻辑；mui.back()仅处理窗口逻辑，若但愿在窗口关闭以前再处理一些其它业务逻辑，则可将业务逻辑抽象成一个具体函数，而后注册为mui.init方法的beforeback参数;beforeback的执行逻辑为：

执行beforeback参数对应的函数若返回false，则再也不执行mui.back()方法；不然（返回true或无返回值），继续执行mui.back()方法；

示例：从列表打开详情页面，从详情页面再返回后但愿刷新列表界面，此时可注册beforeback参数，而后经过自定义事件通知列表页面刷新数据，示例代码以下：

mui.init({
    beforeback: function(){        //得到列表界面的webview
        var list = plus.webview.getWebviewById('list');        //触发列表界面的自定义事件（refresh）,从而进行数据刷新
        mui.fire(list,'refresh');        //返回true，继续页面关闭逻辑
        return true;
    }
});

注意：beforeback的执行返回必须是同步的（阻塞模式），若使用nativeUI这种异步js（非阻塞模式），则可能会出现意想不到的结果；好比：经过plus.nativeUI.confirm()弹出确认框，可能用户还没有选择，页面已经返回了（beforeback同步执行完毕，无返回值，继续执行mui.back()方法，nativeUI不会阻塞js进程）：在这种状况下，若要自定义业务逻辑，就须要复写mui.back方法了；以下为一个自定义示例，每次都须要用户确认后，才会关闭当前页面。

//备份mui.back，mui.back已将窗口关闭逻辑封装的比较完善（预加载及父子窗口），所以最好复用mui.backvar old_back = mui.back;
mui.back = function(){  var btn = ["肯定","取消"];
  mui.confirm('确认关闭当前窗口？','Hello MUI',btn,function(e){    if(e.index==0){        //执行mui封装好的窗口关闭逻辑；        old_back();
    }
  });
}

注意：自定义关闭逻辑时，必定要重写mui.back，不能简单经过addEventListener增长back按键监听， 由于addEventListener只会增长新的执行逻辑，老的监听逻辑依然会执行；

mui.fire()触发自定义事件

按照文档的说明咱们知道有三个参数：（不知道文档在哪里的请戳这里【文档】）

mui.fire( target , event , data )

target为你要传入数据的那个webview，咱们这里是要出入到父webview，因为咱们没有给父webview指定id，咱们前面知道这样就不方便拿到父webview对象，这里就使用当前webview的parent()间接获取。
event是你能够指定的自定义事件名称。
data是你要传入的数据，为json格式 (不知道json为什么物的同窗请戳我上一篇文章mui初级入门教程（三）— html5+ XMLHttpRequest 与mui ajax用法详解) 。

咱们获取数据也很简单：

// 添加targetTab自定义事件监听window.addEventListener('targetTab',function(event){      // 得到选项卡点击事件参数
      var targetTitle = event.detail.targetTitle;      var targetTab = event.detail.targetTab;      //接下来这里拿到数据后写逻辑代码了...});