enianAdmin v1.0开发文档

简单的单页应用sapp.js插件 0.2.x版本

  • 依赖jquery.js

sapp.render(obj) 渲染页面

obj对象属性

属性名 是否必须 类型 解释
subpageObj obj 所切换页面的对象 url,title等
updateUrlBar bool 更新地址栏,默认false,不更新
done func 回调
sign bool/arr 标记,一个传输get的标识,值为true,使用默认;false 则不传输改参数,自定义:[‘tag’,2]【默认值:true】
errorConfig bool/obj/str 错误配置:
str - 则是一个地址,页面直接请求
bool -true,使用配置默认 ;false,不做操作
obj -包括:
title str 标题(可空)
html str html代码
【注意:此属性默认为false】

使用示例

  1. sapp.render({
  2. subpageObj:argObj
  3. ,elem:'.son-page-body'
  4. ,updateUrlBar:true
  5. //,sign:false
  6. ,errorConfig:{
  7. title:'加载失败'
  8. ,html:'页面加载失败'
  9. }
  10. ,done:function(resultObj){
  11. loadState(resultObj, type)
  12. }
  13. }

sapp.config(obj) 修改全局配置信息

使用方法

  1. //可单独设置一个
  2. sapp.config({
  3. elem:'.son-page-body'
  4. ,errorConfig:{
  5. //title:'失败...',//标题可选
  6. html:'老铁....页面加载失败了'
  7. }
  8. ,sign:['p',2]
  9. })

参数说明

属性 类型 说明
elem str 页面DOM容器
errorConfig obj 错误配置信息
sign arr 请求时传递的一个get参数

默认值查看

  1. //默认配置信息,此配置为全局,但是当sapp.render方法中单独设置了信息,则使用方法中的信息,方法中的信息也不会覆盖到全局
  2. var config ={
  3. elem : 'body'
  4. ,errorConfig :{
  5. title:'页面加载失败'
  6. ,html:'<h2 style="font-size:20px">页面加载失败了~</h2>'
  7. }
  8. ,sign:['PAGE_TYPE',1]
  9. }

sapp.partLoad(obj) 局部加载(render简化版)

obj对象属性

属性名 是否必须 类型 解释
url str 请求地址
elem str DOM,默认使用全局配置中的elem
sign bool/arr 标记,自定义:[‘tag’,2]【默认值:false】,true使用默认全局配置
done func 回调

sapp.html() 更改DOM内容,可传代码

  1. //示例1:
  2. sapp.html("<h1>HELLO WORD<h1>");//一个参数,elem为全局配置elem
  3. //示例2:
  4. sapp.html("#son-body","<h1>HELLO WORD<h1>");//两个参数,参数1指定elem,参数2网页代码

sapp.title(str) 更新标题(立即生效)

  1. sapp.title('我是新标题');

sapp.browserListen(bobj,done) 监听浏览器按钮操作

  1. /*
  2. * 0.1.x
  3. * sapp.browserListen(bobj,jump,done);
  4. * 参数说明:bobj:更新浏览器历史记录,如果首次进入页面使用了cutSubpage方法,bobj必须为null,否则需要传入一个对象
  5. * 对象存在参数,url 必选,title 可选(但是不会更改新标题内容),其他自定义参数...
  6. * jump:可以是一个function 或者是一个 bool ,如果jump返回为false,则不执行插件跳转,如果为true,执行插件跳转。
  7. * 如果是function,在function写每次跳转前执行的内容,需要return true;
  8. * 不想使用插件跳转或自定义跳转,直接 return false;
  9. * done:浏览器加载完成的回调。只有jump为true的时候才有回调。
  10. * 0.2.x
  11. * 参数说明:bobj:更新浏览器历史记录,如果首次进入页面使用了cutSubpage方法,bobj必须为null,否则需要传入一个对象
  12. * 对象存在参数,url 必选,title 可选(但是不会更改新标题内容),其他自定义参数...
  13. * done:监听回调;
  14. */

示例:

  1. //监听浏览器切换页面
  2. sapp.browserListen(null, function(obj) {
  3. //console.log(obj);
  4. //此处可写更新页面操作代码,一般写sapp.render(obj) ...
  5. return false;//阻止默认事件
  6. })