HybridStart

Github

概述

关于

HybridStart是一款基于APICloud的混合应用前端开发框架,提供简洁的引擎能力封装、丰富的UI和插件、清晰的代码管理、简明开发模式,致力于打造最好的多webview混合应用开发体验。

目录结构

           
  |-- docs/                 //文档(开发中移除)
  |-- error/                //APP错误页
  |-- res/                  //APP静态资源
  |-- sdk/ 
  |    |-- modules/             //js插件
  |    |-- font/                //字体图标
  |    |-- core.js              //核心库
  |    |-- server.js            //业务方法
  |    |-- common.js            //页面公用代码
  |    `-- ui.css               //默认UI
  |-- view/                 //APP页面(内附示例,开发中移除)
  |-- config.js             //HybridStart配置
  `-- config.xml            //APICloud配置
            
        

代码组织

HybridStart 项目主要包括SDKView两部分。

SDK包含核心库、插件、公用代码、UI;View包含所有APP页面,APP页面体现为一个至少包含temp.htmlstyle.cssscript.js三个文件的文件夹,页面文件夹在view/中最多嵌套两层,即/view/[...]/page/

开发模式

HybridStart 约定APP的生命周期为 `root -> index(exit) <=> page <=> page ...`,启动页即root通常没有任何可见内容,只执行APP的状态检测、插件调用、监听、数据初始化等操作,完成后直接跳转到用户可见的首页(index),首页与展示页之间任意跳转返回,但要在首页拦截返回键,使(安卓)APP无法返回启动页,而是退出APP,整个生命周期内启动页都在后台运行。

交互约定

约定前后端交互数据基本格式如下:

          
{
    "status": "Y",      //请求的状态 "Y"/"N",也可以根据情况扩展其他
    "data": [{...}],    //请求的数据 数组或对象
    "msg": "",          //【可选】服务端提示信息
    "count": [number]   //【可选】当获取列表数据时,需附加count数据指明列表总数,用于前段判断是否还有更多
}
          
        

快速开始

  1. 在APICloud平台创建新项目,添加以下模块:UIPullRefreshFlash、ajpush、bMap、mam
  2. 将代码检出到本地,备份config.xml中的appid信息并清空所有文件
  3. 将本项目除了docs/以外所有文件拷贝进来,修改新config.xml里的appid
  4. 提交代码,平台打包

详细过程参见如何快速开发一款混合应用?

命令行工具

npm i安装依赖

npm run init开启WiFi调试,默认端口8686

npm run sync增量同步,注意:init命令将持续占用命令行窗口,此时需要另开一个命令行窗口执行同步操作

npm run stop关闭WiFi调试

npm run build编译sdk/ui.less到sdk/ui.css

配置

config.xml包含原生层面的所有配置,详情参考config.xml应用配置说明,另外如果需要应用内升级,请一定记得修改config.xml里的scheme值,否则IOS9以上系统无法升级

            
    <preference name="urlScheme" value="hybridstart" />
    <preference name="querySchemes" value="hybridstart" />
            
        

config.js文件是HybridStart的全局配置,所有配置信息挂载在appcfg对象上,包含APP开发的全部配置,也可以自行扩展其他配置。

默认如下:

host

请求域名管理

control 普通api域名
source 静态资源域名
upload 上传地址

set

APP常规设置

version APP版本,默认"0.0.1"
outime 超时时间,默认10000
longtime 加长超时时间,默认20000
windowAnimate

窗口动画,默认"push",可选

                                    
none            //无动画效果
push            //新视图将旧视图推开
movein          //新视图移到旧视图上面
fade            //交叉淡化过渡(不支持过渡方向)
                                    
                                
animateSubType

窗口动画方向,默认"from_right",可选

                                    
from_right          //从右边开始动画
from_left           //从左边开始动画
from_top            //从顶部开始动画
from_bottom         //从底部开始动画
                                    
                                
animateDuration 窗口动画效果时长,默认300
safeStorage 受保护的本地存储键,清理缓存时不会清除,多个值用半角逗号隔开,默认"user,appInit,rights"
temporary 临时本地存储键,退出APP自动清除,多个值用半角逗号隔开,默认"templateCache,gps"

ajax

ajax相关设置

method 默认请求方式,默认"get"
crypto

请求加密相关设置,默认

                                    
{
    enable: false,
    key: "abc123",
    url: ""
}
                                    
                                

默认加密算法是3DES,如果开启加密,secret值存储在/res/key.xml加密文件中

loading

加载动画设置

text 显示文字,默认"正在加载"
title 显示标题,默认""
anim 显示动画,默认"fade",可选"fade/zoom"

pull

下拉刷新插件设置

bgColor 下拉部分背景色,默认"#C0C0C0"
loadAnimInterval 图片播放间隔,默认200
isScale 播放下拉过程中的关键帧动画时,是否同时添加等比同步缩放效果;默认true
image

下拉刷新相关图片设置;若不传则使用默认图标,例如:

                                    
{
    pull: [
        "widget://res/img/refresh/dropdown0.png",
        "widget://res/img/refresh/dropdown1.png",
        "widget://res/img/refresh/dropdown2.png",
        "widget://res/img/refresh/dropdown3.png",
        "widget://res/img/refresh/dropdown4.png",
        "widget://res/img/refresh/dropdown5.png",
        "widget://res/img/refresh/dropdown6.png"
    ],
    load: [
        "widget://res/img/refresh/loading0.png",
        "widget://res/img/refresh/loading1.png",
        "widget://res/img/refresh/loading2.png",
        "widget://res/img/refresh/loading3.png",
        "widget://res/img/refresh/loading4.png"
    ]
}
                                    
                                

plugin

插件相关设置,便于集中配置插件效果,默认

                        
{
    bdmap: {
        zoomLeval: 18
    }
}
                        
                    

下载

Github

直接下载:master.zip

NPM

npm i hybridstart

体验APP

体验APP只提供安卓版本:小米应用商店 PP助手

SDK

Core

如没有特殊说明,app对象上的方法均依赖runtime,且支持安卓和IOS双平台。

app.util

内部工具包,不依赖runtime,包括选择器及其他常用方法,大部分代码来自mui,建议使用前存为变量var $ = app.util;

方法
$(selector, [context])

元素选择器,selector参数支持css选择器和原生DOM元素,用于获取DOM元素并返回元素对象,并支持以下扩展方法:

each

遍历,$ele.each(callback)

on

事件绑定/委托,$ele.on(eventType, [child], handle)

tap

点击事件,$ele.tap([child], handle)

trigger

触发事件,$ele.trigger(eventType, data)

data

设置/获取对象的dataset,$ele.data(attribute, [value])。取值优先取元素显性设置的"data-attribute"属性值,如果没有再获取dataset,设置值将统一设置dataset

$.extend(target,source...,deepCopy)

合并对象,用法同jQuery

$.each(elements, callback, hasOwnProperty)

对象、数组遍历方法

$.type(obj)

返回对象类型

$.isArray(obj)

返回对象是否为数组格式

$.isPlainObject(obj)

返回对象是否为纯粹对象

$.isFunction(obj)

返回对象是否为函数

$.trim(string)

返回去除首尾空字符后的字符串

$.trigger(element, eventType, eventData)

触发事件

示例
                    
var $ = app.util;
$('#view').on('touchend', '.item', function(i, e){
    console.log($(e).data('uuid'));
});
                    
                
app.ready(callback)

原生runtime就绪回调,显然不依赖runtime。

示例
                    
app.ready(function(){
    console.log(api.appId); 
});
                    
                
app.exit(silent)

退出APP,若silent为真值将没有确认信息直接退出。

示例
                    
app.exit();
                    
                
app.subscribe(eventName, callback)

接收名称为eventName的事件,并执行回调callback

示例
                    
app.subscribe('hello', function(msg){
    console.log('hello ' + msg);
});
                    
                
app.publish(eventName, msg)

发布名称为eventName的事件,附带消息msg,将在接收事件回调中接收

示例
                    
app.publish('hello', 'world!');
                    
                
app.on(event, callback)

APP系统事件监听。

支持事件
batterylow

电量低事件,返回格式

                                
{
    level:100,            //电池电量(0-100)
    isPlugged:true        //是否连接电源
}
                                
                            
batterystatus

电池状态变化事件,返回格式

                                
{
    level:100,            //电池电量(0-100)
    isPlugged:true        //是否连接电源
}
                                
                            
offline

监听设备断开网络的事件

online

监听设备连接到网络的事件

pause

应用进入后台事件

resume

应用从后台回到前台事件

shake

设备摇动事件

示例
                    
app.on('pause', function(){
    console.log('app进入后台'); 
});
                    
                
app.key(keyName, callback)

手机按键监听。

支持按键
keyback

返回键

keymenu

菜单键

示例
                    
app.key('keyback', function(){
    console.log('按下了返回键'); 
});
                    
                
app.off(keyName)

取消事件监听,支持系统事件、自定义事件以及按键监听。

示例
                    
app.off('hello');       //取消自定义事件
app.off('keyback');     //取消按键监听
app.off('pause');       //取消内置事件
                    
                
app.getParam()

获取页面参数,不依赖runtime,仅支持使用app对象方法打开的页面。

示例
                    
var pageParam = app.getParam();
console.log(pageParam);
                    
                
app.openView(param, leval1, [leval2])

跳转/打开页面,leval1和leval2分别代表页面在view/内的两级文件夹路径,leval2选填,openView将打开路径文件夹内的temp.html页面,因此view/内最多支持两级目录。详细参数:

param

当param不是对象时,将作为参数直接传递给新页面;若为对象类型可以传入更多配置,详见下文;若既不需要传参也不需要修改配置,则要传入null/undefined占位。

param.param

将传递给新页面的参数,可以在新页面内用app.getParam()方法同步获取到;如果所传参数是对象类型,也可以通过api.pageParam获取,但需等待runtime就绪,不建议使用。

param.duration

页面切换动画时长,单位ms,默认应用全局配置appcfg.set.animateDuration

param.anim

页面切换动画类型,支持类型见app.window.open(),默认应用全局配置appcfg.set.windowAnimate

param.fullPath

默认false,是否将参数leval1的值作为页面完整地址访问,可以用于访问view/之外的页面。

param.pop

默认false,是否以弹窗形式打开。

若为true,还可以传param.topparam.height,指示弹层的顶部位置和高度,默认都是0

param.bar

默认false,是否以带标题栏的方式打开。

若为true,还可以传param.title作为标题内容

param.closeself

默认false,是否跳转到新页面后关闭当前页面

param.closeback

默认false,是否跳转到新页面后关闭所有后台页面

leval1

目标页面在view/内的一级目录

当leval1是url时,将以web页面形式打开,此时将忽略leval2

leval2

目标页面在view/内的二级目录,若没有二级目录可以省略

示例
                    

app.openView(null,'news');              //将打开 "view/news/temp.html"

app.openView(null,'news','detail');     //将打开 "view/news/detail/temp.html"
                    
                
app.loading

打开/关闭等待提示。

方法
show([msg], [config])

显示loading,msg为等待提示文字,默认appcfg.loading.text。config配置如下:

title

提示标题,默认appcfg.loading.title

anim

动画类型,支持"fade/zoom",默认appcfg.loading.anim

modal

默认true,是否模态

delay

延时关闭时间,单位ms,默认0

hide()

关闭loading

示例
                    
app.loading.show();

setTimeout(function(){
    app.loading.hide();
},2000);
                    
                
app.pull

设置/复位window或frame的下拉刷新状态。

方法
init(callback)

初始化下拉刷新功能,callback是触发回调,必填,其他配置见appcfg.pull

stop()

停止下拉刷新效果,恢复到正常状态

示例
                    
app.pull.init(function(){
    console.log('触发下拉刷新');

    setTimeout(function(){
        app.pull.stop();    //复位下拉刷新状态
    }, 2000); 
});
                    
                
app.toast(msg, config)

打开一个自动关闭的提示消息,config也支持传入整数,表示延时关闭毫秒数。

配置
global

默认false,是否是全局的toast。若为false,toast将只在当前window范围可见

position

显示位置,默认"bottom",可选"top/middle/bottom"

delay

延时关闭时间,默认700,单位ms

onclose

关闭回调函数,默认null

示例
                    
app.toast('hello toast!');
                    
                
app.alert(msg, sureHandle, config)

弹出带一个按钮的对话框。msg是提示文字,sureHandle是点击回调,config配置如下:

配置
title

对话框标题,默认无

buttons

按钮文字设置,默认["确定"]

示例
                    
app.alert('Are you sure?', function(){
    console.log('点击确定的回调');
});
                    
                
app.confirm(msg, sureHandle, cancelHandle, config)

弹出带两个按钮的确认对话框。msg是提示文字,sureHandle是确认回调,cancelHandle是取消回调,config配置如下:

配置
title

对话框标题,默认无

buttons

按钮文字设置,默认['确定', '取消']

示例
                    
app.confirm('Are you sure?', function(){
    console.log('点击确定的回调');
}, function(){
    console.log('点击取消的回调');
});
                    
                
app.prompt(sureHandle, cancelHandle, config)

弹出一个带两个按钮的输入框,sureHandle是确认回调,cancelHandle是取消回调,回调函数将接收用户输入内容,config配置如下:

配置
title

输入框标题,默认无

title

输入框提示文字,默认无

text

输入框默认内容,默认无

type

输入框文字内容,默认"text",可选text、password、number、email、url

buttons

按钮文字设置,默认['确定', '取消']

示例
                    
app.prompt(function(text){
    console.log('输入了:' + text);
}, function(){
    console.log('取消输入的回调');
});
                    
                
app.actionSheet(config, callback)

弹出系统选择按钮框,callback接收点击按钮的序号,config配置如下:

配置
title

标题,默认无

cancelTitle

取消按钮文字,默认'取消'

destructiveTitle

唯一一个红色按钮文字,默认无

buttons

按钮组,必填,例如['a','b','c']

示例
                    
app.actionSheet({
    title: '选择头像',
    buttons: ['拍摄', '相册选择']
}, function(idx){
    console.log('点击按钮:' + idx);
});
                    
                
app.storage.val(key, [value])

存储/读取值,支持对象类型自动转化。

示例
                    
app.storage.val('test', {a:1});

console.log( app.storage.val('test') )   //{a:1}
                    
                
app.storage.remove(key)

删除本地存储key的值

app.storage.leaveSpace()

返回本地存储剩余空间,单位byte

app.storage.clear(force)

清除本地存储,默认跳过appcfg.set.safeStorage中设置的key,除非force为真值。

app.window.open(config)

跳转/打开窗口。

配置
name

窗口名称,不传将自动生成

url

页面url,必须

param

传递给新页面的参数,可以使用app.getparam()方法获取

anim

打开窗口的动画效果,默认appcfg.set.windowAnimate

duration

打开窗口动画的时长,单位ms,默认appcfg.set.animateDuration

示例
                    
app.window.open({
    url: '../view/index/temp.html'
});
                    
                
app.window.close([winName], [config])

关闭名称为winName的窗口,若不传winName将关闭当前window或frame。config配置如下:

anim

关闭窗口的动画效果,默认appcfg.set.windowAnimate

duration

关闭窗口动画的时长,单位ms,默认appcfg.set.animateDuration

isFrame

如果winName是frame的名称,需要设置为真值,默认false

示例
                    
app.window.close();     //关闭当前window或Frame
                    
                
app.window.on(event, callback)

窗口事件监听,手势事件支持浮动窗口。

支持事件
pause

页面退到后台事件。

resume

页面回到前台或初次显示事件。

scrolltobottom

页面滚动到底部事件。

swipleft

从左向右滑动事件。

swipright

从右向左滑动事件。

swipup

从上向下滑动事件。

swipdown

从下往上滑动事件。

示例
                    
app.window.on('resume', function(){
    console.log('页面正在前台'); 
});
                    
                
app.window.evaluate(name, [frameName], scriptContent)

在名称为name的窗口,或name窗口内名称为frameName的浮动窗口中,执行脚本scriptContent。

示例
                    
app.window.evaluate('member_index', 'app.window.close()');
                    
                
app.window.openPopover(config)

打开Frame窗口,Frame窗口的window对象上将扩展selfTop属性,值为自身距离屏幕底部距离。

配置
name

Frame窗口名称,不传将自动生成

url

Frame窗口url,必须

param

传给Frame窗口的参数,可以使用app.getparam()方法获取,如果是对象类型也可以通过api.pageParam获取,但该方法需要等待runtime就绪。

left

Frame窗口距屏幕左边缘距离,默认0

top

Frame窗口距屏幕上边缘距离,默认0

width

Frame窗口宽度,默认'auto',将横向充满屏幕

height

Frame窗口高度,默认'auto',将纵向充满屏幕

bottomMargin

Frame窗口距离底部距离,默认0,不可与height同时使用

bounce

Frame窗口是否支持弹动效果,默认false

示例
                    
app.window.openPopover({
 url: './content.html',
 top: 40
});
                    
                
app.window.popoverElement(config)

在指定元素区域打开浮动窗口。

配置
id

指定元素的id,必须

url

打开浮动窗口的url,必须

name

打开浮动窗口的名称,不传将自动生成

bounce

浮动窗口是否支持弹动效果,默认false

param

传给浮动窗口的参数,可以使用app.getparam()方法获取。

示例
                    
app.window.popoverElement({
    id: 'view',
    url: './content.html'
});
                    
                
app.window.setPopover(config)

设置指定浮动窗口的属性。

配置
name

要修改的Frame窗口名称,必须

bounces

Frame窗口是否有弹动效果

hidden

Frame窗口是否隐藏

bgColor

Frame窗口背景色

vScrollBarEnabled

Frame窗口是否显示垂直滚动条

hScrollBarEnabled

Frame窗口是否显示水平滚动条

scaleEnabled

Frame窗口是否可以缩放

rect

Frame窗口位置及尺寸,格式

                                
{
    x:0,                 //左上角x坐标
    y:0,                 //左上角y坐标
    w:320,               //宽度,若传'auto',页面从x位置开始自动充满父页面宽度
    h:480                //高度,若传'auto',页面从y位置开始自动充满父页面高度
}
                                
                            
示例
                    
app.window.setPopover({
   name: 'pop_detail',
   hidden: true 
});
                    
                
app.window.animPopover(config)

frame窗口动画。

配置
delay

动画执行延迟时间,单位ms,默认0

duration

动画时长,单位ms,默认appcfg.set.animateDuration

curve

动画曲线类型,默认'ease_in_out,可选

                                
ease_in_out        //开始和结束时慢
ease_in            //开始时慢
ease_out           //结束时慢
linear            //整个动画过程速率一样
                                
                            
repeatCount

动画重复次数,默认0

translation

位置平移参数,格式

                                
 {
    x: 0,
    y: 0,
    z: 0
}
                                
                            
示例
                    
app.window.animPopover({
    name: 'news_detail',
    translation: {
        x: 320
    }
});
                    
                
app.ajax(option)

跨域异步请求。

配置
method

请求方式,默认appcfg.ajax.type,支持常规get,post,put,delete,head,options,trace,patch,额外增加payload

dataType

请求数据格式,默认"json"

checkData

是否检查约定数据格式,仅当dataType为"json"时有效,默认true

timeout

超时时间,默认appcfg.set.outime / 1000,单位s

snapshoot

是否开启快照缓存,默认false

url

请求url

data

发送数据

success

请求成功回调,接受返回数据

error

请求失败回调,接收错误信息对象,若不传将使用默认错误提示

返回方法
abort()

中止本次请求。

clearSnapshoot()

清除本请求地址的快照缓存。

示例
                    
app.ajax({
    url: appcfg.host.control + '/login',
    data: {
        ...
    },
    success: function(res){
        //
    }
});
                    
                
app.device.os()

获取设备系统信息。返回数据格式:

                    
{
    name: "android",    //系统名称
    version: "6.1"      //系统版本
}
                    
                
示例
                    
var os = app.device.os();
console.log(os);
                    
                
app.device.screen()

获取设备屏幕信息。返回数据格式:

                    
{
    resolutionHeight: "1080",   //设备高度物理像素数
    resolutionWidth: "640",     //设备宽度物理像素数
    width:"320",                //设备宽度像素数
    height:"540"                //设备高度像素数
}
                    
                
示例
                    
var screen = app.device.screen();
console.log(screen);
                    
                
app.device.uuid()

返回设备唯一标识,字符串类型。

示例
                    
var uuid = app.device.uuid();
console.log(uuid);
                    
                
app.device.model()

返回设备型号,字符串类型。

示例
                    
var model = app.device.model();
console.log(model);
                    
                
app.device.connect()

返回当前网络连接类型。支持以下类型:

                    
unknown            //未知
ethernet        //以太网
wifi            //wifi
2g                //2G网络
3g                //3G网络
4g                //4G网络
none            //无网络
                    
                
示例
                    
var connect = app.device.connect();
console.log(connect);
                    
                
app.device.call(number, [propt])

拨打电话,默认直接拨打,propt为真值将弹出一个确认提示。

示例
                    
app.device.call('10086');
                    
                
app.device.setWakeLock([keepOn])

设置设备休眠状态,keepOn为真值设备将保持常亮。

示例
                    
app.device.setWakeLock(true);
                    
                
app.device.setBadge(number)

设置应用角标数字。

示例
                    
app.device.setBadge(1);
                    
                
app.device.install(appUri)

安装应用。

示例
                    
var os = app.device.os();
var appUri = (os.name==='android' ? 'file://xxx.apk' : 'https://list.kuaiapp.cn/list/KuaiAppZv7.1.plist');
app.device.install(appUri);
                    
                

Modules

内置模块化插件列表,部分插件间存在依赖关系。

jQuery

内置jQuery 3.x模块化封装。

示例
                    
var $ = require('jquery');
console.log( $ );
                    
                
validform

表单验证插件,依赖jQuery插件。来自Flow-UI,请求方法用app.ajax()代替,API及示例参考Flow-UI Validform

album

大图全屏播放插件,依赖slide\jQuery插件。来自Flow-UI,针对移动端微调,API及示例参考Flow-UI Album

base

辅助方法。来自Flow-UI,API及示例参考Flow-UI Base

countdown

倒计时插件。来自Flow-UI,API及示例参考Flow-UI Countdown

datepicker

日期选择器插件,封装AppianZ/DateSelector

download

下载插件,返回下载方法。

配置
path

下载地址,默认"fs://Download/"

name

存储名称,默认无。

onCreate()

创建下载成功回调,默认app.toast('正在下载');

onCreateError(err)

创建下载失败回调,默认app.toast('创建下载失败:' + err.msg);

onStatus(percent)

下载进度变化回掉,默认app.toast('正在下载:' + percent + '%');

success(savePath, fileSize)

下载完成回调,默认无

error(status)

下载失败回调,默认

                                
if (status === 2) {
    app.toast('下载失败');
} else {
    app.toast('下载异常,status:' + status);
}
                                
                            
返回对象
abort()

中止该下载任务。

示例
                    
var download = require('download');
download("http://static-zt.oss-cn-qingdao.aliyuncs.com/mock/notice2.zip", {
    name: 'download-test.zip',
    success: function(savePath, fileSize) {
        app.toast('下载完成:' + savePath);
    }
});
                    
                
echarts

图表插件,封装百度Echarts

etpl

前端模板引擎,封装百度Etpl

input-number

数字输入插件,依赖jQuery\input插件。来自Flow-UI,API及示例参考Flow-UI inputNumber

input

输入框插件,依赖jQuery插件。来自Flow-UI,API及示例参考Flow-UI input

lazyload

图片懒加载jQuery插件。来自Flow-UI,API及示例参考Flow-UI lazyload

multi-picker

选择器插件,封装AppianZ/MultiPicker

option-list

带左划菜单的列表插件,依赖jQuery\etpl插件以及默认UI。

配置
selector

列表生成容器的选择器,默认"body"

multiShow

允许多个列表项同时显示菜单,默认false

duration

回弹时长,字符串格式,默认"300ms"

touchClass

触摸操作时添加的class,默认"active"

返回对象
data

返回实例数据。

add(newData, prepend)

向列表末尾追加元素,newData为对象格式,prepend为真值将向列表头部添加元素。

set(data)

重新设置列表数据,data为对象数组,格式见示例。

delete(itemIndex)

删除列表项

示例
                    
var $ = app.util;
//列表数据格式
var listData = [{
        item: '左滑操作列表0',
        className: 'first'
    }, {
        item: '左滑操作列表1'
    }, {
        item: '左滑操作列表2'
    }];
//侧滑操作列表
require.async('option-list', function(optionList) {
    var demo = optionList({
        selector: '#controlList',
        data: listData,
        buttons: [{
            text: '编辑'
        }, {
            text: '添加'
        }, {
            className: 'btn-danger',
            text: '删除'
        }],
        onClick: function(button, itemIndex, itemLength) {
            var optionIndex = $(button).data('index');
            switch(optionIndex){
                case "0":
                    app.toast(demo.data[itemIndex].item);
                    break;
                case "1":
                    demo.add({
                        item: '左滑操作列表' + demo.data.length
                    });
                    break;
                case "2":
                    demo.delete(itemIndex);
                    break;
                default:
                    console.log('optionlist:error');
            }
            
        }
    });
});
                    
                
paging-load

分页加载插件,来自Flow-UI,API及示例参考Flow-UI pagingLoad

render

单向绑定渲染器,依赖jQuery\etpl插件。来自Flow-UI,API及示例参考Flow-UI render

scroll-col

滚动插件,依赖jQuery\easing插件。来自Flow-UI,API及示例参考Flow-UI scrollCol

scroll-load

滚动加载插件,依赖jQuery\base插件。来自Flow-UI,API及示例参考Flow-UI scrollLoad

slide

图片轮显插件,依赖jQuery\base插件。来自Flow-UI,API及示例参考Flow-UI slide

upload

上传插件,返回上传方法。依赖base插件。语法upload(localImgPath, option)

配置
url

上传地址,默认无

headers

请求头,对象格式,默认{}

data

附带参数,json格式

onCreate(upId)

创建上传成功回调,默认app.toast('正在上传...');

onCreateError()

创建上传失败回调,默认app.toast('创建上传失败');

onStatus(percent)

上传进度变化回调,默认app.toast('正在上传:' + percent + '%');

success(remoteUrl)

上传成功回调,默认无。

error

上传失败回调,默认app.toast('上传失败');

返回对象
abort()

中止该上传任务。

示例
                    
require.async('upload', function(uploader) {
    uploader('widget://res/img/avat.jpg', {
        url: "http://host.refined-x.com/test/fileupload.php",
        success: function(newAvat) {
            console.log('上传成功:' + newAvat);
        }
    });
});
                    
                

UI

定制主题

基于less实现主题定制,less文件与ui.css同目录。

组件列表

UI组件示例见演示app。

grid

12列栅格组件,来自Flow-UI,api及示例参见Flow-UI grid

button

按钮组件,来自Flow-UI,样式微调,api及示例参见Flow-UI button

color

色彩组件,来自Flow-UI,去掉了辅助色(auxiliary),api及示例参见Flow-UI color

badge

徽标组件

.badge

定义一个徽标元素

.badge-primary

叠加在.badge上以显示为主色调(另:"success", "info", "warning", "danger")

list

列表组件。

.list

定义一个列表元素,默认内部H标签和p标签将单行显示,超出隐藏。

.item

在.list元素内定义一个列表项。

.item-lite

叠加在.item上使成为一个紧凑列表项。

.active

叠加在.item上显示为点击状态。

.item-text-wrap

叠加在.item上使文字可换行

.item-divider

叠加在.item上使成为带背景的分隔项。

.item-note

在.item内定义一个右侧备注元素。

.item-icon-left

叠加在.item上为左侧图标预留空间。

.item-icon-right

叠加在.item上为右侧图标预留空间。

.item-button-left

叠加在.item上为左侧按钮预留空间。

.item-button-right

叠加在.item上为右侧按钮预留空间。

.item-image

在.item内定义一个图片包裹元素,内部图片将100%填充。

.item-avatar

叠加在.item上为左侧头像图片预留空间。

.item-avatar-right

叠加在.item上为右侧头像图片预留空间。

.item-thumbnail

叠加在.item上为左侧缩略图片预留空间。

.item-thumbnail-right

叠加在.item上为右侧缩略图片预留空间。

.item-body

在.item内定义一个内容块,文字可以换行显示。

.item-badge

叠加在.item上为.badge元素在右侧预留空间。

card

卡片组件。

.card

定义一个卡片元素,或叠加在.list上成为卡片式列表。

card-head

定义一个卡片头部。

card-title

在卡片头部内定义一个标题。

card-foot

定义一个卡片底部。

form

表单组件。基于.item扩展。

.item-input

叠加在.item上定义一个输入项,内部input/textarea标签将自动应用样式。

.item-stacked-label

叠加在.item-input上使成为一个带提示文字的输入项。

.input-label

在.item-stacked-label定义一个提示文字元素。

.item-checkbox

叠加在.item上定义一个多选元素项。

.checkbox

在.item-checkbox内定义一个多选状态指示符。

.checkbox-primary

叠加在.checkbox上使指示符应用主色调,可选颜色组件中的所有颜色。

.item-radio

叠加在.item上定义一个单选元素项。

.radio-primary

叠加在.radio上使指示符应用主色调,可选颜色组件中的所有颜色。

.item-select

叠加在.item上定义一个选择项,内部select元素将自动应用样式。

toggle

开关组件。基于.item扩展。

.item-toggle

叠加在.item上定义一个开关项。

.toggle

在.item-toggle内定义一个开关。

.toggle-primary

叠加在.toggle上使指示符应用主色调,可选颜色组件中的所有颜色。

range

滑块组件。基于.item扩展。

.range

叠加在.item上定义一个滑块容器,内部input[type="range"]将自动应用样式。

.range-label

在.range内定义一个内容指示器。

flex-grid

Flex栅格组件,来自Flow-UI,样式微调,api及示例参见Flow-UI flex

rect

比例矩形组件,来自Flow-UI,样式微调,api及示例参见Flow-UI rect

space

间距组件,来自Flow-UI,样式微调,api及示例参见Flow-UI space

tools

工具类。

.fix

清除浮动。

.oh

超出隐藏。

.l/.r

左/右浮动。

.pr/.pa

相对/绝对定位。

.tc/.tl/.tr

中/左/右对齐。

.el

单行文字,超出显示...

.hide

隐藏元素。

.hidetext

隐藏内部文字。

.opc0

透明元素。

.big

大字号。

.small

小字号。

head

头部组件。

.head

定义一个头部元素。

.title

定义一个标题。

.btn

.head内.btn:first和.btn:last元素分别显示在头部左侧和右侧。

.item-input-inset

定义一个头部输入框。

foot

底部导航组件。

.foot

定义一个底部导航容器。

.tabs

在.foot内定义一个导航组件。

.tabs-ion-top

叠加在.tabs上显示为带图标的导航。

.tabs-text

叠加在.tabs上显示为纯文字导航。

.tab-item

在.tabs内定义一个菜单项,自适应宽度。

.cur

叠加在.tab-item上显示为当前状态。

.active

叠加在.tab-item上显示为触摸状态。

listPlaceholder

暂无内容组件。

.listPlaceholder

定义一个暂无内容元素。

._container

在.listPlaceholder内定义一个容器元素。

._icon

在._container内定义一个图片区域。

._text

在._container内定义一个文字区域。

picControl

图片上传组件,参考示例APP中的图片上传示例。

.picControl

定义一个图片上传队列组件。

.bordered

叠加在.picControl上显示为带边框组件。

._adder

在.picControl内定义一个添加图片按钮。

._pic

在.picControl内定义一个图片元素,内部需包含img元素。

._del

在._pic元素内定义一个删除按钮,内部需包含.ion图标。

._state

在._pic元素内定义一个上传进度元素。

other

辅助类。

img[data-src]

懒加载图片默认占位。

img[data-remote]

待缓存图片默认占位,该功能在sdk/server.js中。

.onKeyboard

打开键盘时body自动添加该类,该功能在sdk/common.js中。

.block-holder

将元素/图片修饰为占位元素。

解决方案

请求加密

开启请求加密,需要将配置文件中的appcfg.ajax.crypto.enable设置为true,并填写加密接口appcfg.ajax.crypto.url,默认使用3DES加密算法,加密密码保存在res/key.xml中,打包后自动加密,使用apicloud专用api获取。

发送请求

加密请求将集中发送到加密接口,请求数据格式为:

            
{
    data: secureDataStr,    //加密数据
    sign: sign              //签名
};
            
        

加密数据secureDataStr的生成过程为:先将原请求按如下格式组织:

            
{
    data: opt.data,
    url: opt.url
}  
            
        

再经JSON.stringify得到原请求数据字符串,然后用3DES方式加密得到加密数据。

签名的生成过程为:将原请求数据字符串与加密密码拼接,取MD5值。

解密数据

加密接口需要返回3DES加密后的数据字符串,客户端将使用3DES算法解密,并经JSON.parse解析为json格式,返回给回调函数。

快照缓存

为app.ajax配置snapshoot:true即可开启快照缓存,即把每一次成功返回的ajax结果保存为快照,下次发起相同请求(判断依据是url和参数相同)时第一时间将快照取出返回给回调函数,待真实数据返回后校验与快照是否相同(需要数据为json格式),若相同则缓存命中,不同则再次调用回调函数并传入真实数据,为了使业务中能够区分出快照,会为快照数据添加一个'snapshoot'属性值为'true'。

示例

            
app.ajax({
    url: appcfg.host.control + '/login',
    data: {
        ...
    },
    snapshoot: true,
    success: function(res){
        //
    }
});
            
        

图片缓存

默认server.js中封装了cacheImg()方法,用于实现图片本地缓存:

            
/*
* cacheImg(element, callback)
* @element: 目标元素,将自身或子元素的"data-remote"属性值作为图片地址进行缓存,并自动应用到图片的src属性或普通元素的background-image样式。
* @callback: 全部缓存结束后的回调函数
*/
var $ = app.util;
var server = require('sdk/server');
server.cacheImg($('#view'), function() {
    console.log('缓存成功!');
});
            
        

数据预取

数据预取通常用来在APP启动时预先获取初始化数据,当需要预取多个数据时候,就需要类似Promise.all()的功能,但原生的请求方法不支持返回Promise,因此server.js中封装了一个preGet()方法,用于获取多个异步数据并回调,预取的数据将存贮在LocalStorage。预取数据需要在server.js中自行添加。

            
//在server.js中配置预取请求,数组形式
preGet.prototype.preGetList = [{
    key: 'websiteConfig',   //预取数据存储key
    url: appcfg.host.control + '/websiteConfig',    //预取数据地址
    data: {}    //预取数据参数
}];
            
            
//数据预取
var server = require('sdk/server');
server.preGet(function(){
    console.log('数据预取完成');
});
            
        

自动更新

借助平台的版本管理机制实现APP自动更新,config.xml默认已配置autoUpdate,APP启动时将自动检测新版本并提示,另外server.js中封装了一个checkUpdate()方法,用于应用内手动检测更新。

            
var comm = require('sdk/server');
comm.checkUpdate();
            
        

消息推送

框架内置基于极光推送实现的推送机制,root页面默认包含推送初始化代码,config.xml中的极光app_key需要自己申请并替换,server.js中封装了push对象,包含open()和close()两个方法,用于实现推送开关,具体实现参见view/member/set/script.js

社区

专题文章

HybridStart专题

讨论群

361917044