开发使用文档

当前版本:v1.0.1

快速使用

1. 引入uim.js




<script src="../js/uim.js"></script>

2. 初始化uim




uim.init({
  config: {
      app_id: 1,
      socket: {...},
      report_error: true, // 自动上报js错误信息
      api: {
          error: function (err) {
              layer.alert(err.description)
          },
          hook: {...},
          cache: {...},
      }
  },
  // 会话验证成功
  success: function () {
      console.log('验证会话成功', uim.session);
  },
  // 未登录或登录失效
  error: function () {
      console.log('未登录')
      location = '/login.html'
  },
});

参数配置
属性名 说明 默认值 示例
整理中 整理中 整理中 整理中
模板渲染

uim自带的模板渲染引擎来自于UIM服务器端异步解析页面、邮件、推送等内容的需求,主要是为满足架构上对安全性的要求,因此与其他众多模板引擎相比并没有效率上的优势,但在一般的小量解析场景中使用并无明显区别。浏览器端使用uim进行模板解析有助于统一语法,提高模板的可读性、可维护性与可重用性。

uim.render({
    data: data,                     // 数据对象
    template: '#tpl-select-group',  // 模板
    template_type: 1,               // 0为(默认)模板内容字符串(不支持include),
                                    // 1为标签对象(取innerHTML,包含include标签时将使用document.getElementById来取),
                                    // 2为在线模板(包含include时将使用uim.api.emit调用接口从线上获取);
    cache: false,                   // 调用接口从线上获取模板时是否进行缓存,当template_type=2时有效
    context: window,                // 用于在当前上下文中寻找dom(当template_type=1时)与变量
    target: '.select-group',        // 解析后放入的dom对象,非必传
    done: function (res) {
        // 解析完成后的回调,res格式:{error:'',content:''}
    }
})