Seajs 简易文档 提供简单、极致的模块化开发体验
前端之家收集整理的这篇文章主要介绍了
Seajs 简易文档 提供简单、极致的模块化开发体验,
前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
非官方文档,整理来自己文档的文字与实例,方便速查。
为什么使用 Sea.js ?
Sea.js 追求简单、自然的代码书写和组织方式,具有以下核心特性:
简单友好的模块定义规范:Sea.js 遵循 CMD 规范,可以像 Node.js 一般书写模块代码。
自然直观的代码组织方式:依赖的自动加载、配置的简洁清晰,可以让我们更多地享受编码的乐趣。
Sea.js 还提供常用插件,非常有助于开发调试和性能优化,并具有丰富的可扩展接口。
兼容性
Sea.js 具备完善的测试用例,兼容所有主流浏览器:
Chrome 3+
Firefox 2+
Safari 3.2+
Opera 10+
IE 5.5+
Sea.js 可运行在 Mobile 端,包括 Hybrid 模式的 App 上。理论上,Sea.js 可以运行在任何浏览器引擎上。
seajs.configObject
alias
Object
别名配置,配置之后可在模块中使用require调用 require('jquery');
<div class="jb51code">
<pre class="brush:js;">
seajs.config({
alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' }
});
<div class="jb51code">
<pre class="brush:js;">
define(function(require,exports,module) {
//引用jQuery模块
var $ = require('jquery');
});
paths
Object
设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base的情况下指定到某个目录。
加载的是 https://a.alipayobjects.com/gallery/underscore.js
});
vars
Object
变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars 变量来配置。
vars 配置的是模块标识中的变量值,在模块标识中用 {key} 来表示变量。
加载的是 path/to/i18n/zh-cn.js
});
map
Array
该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。
加载的是 path/to/a-debug.js
});
preload
Array
使用preload配置项,可以在普通模块加载前,提前加载并初始化好指定模块。
preload中的空字符串会被忽略掉。
注意:preload中的配置,需要等到 use 时才加载。比如:
// 在加载 b 之前,会确保模块 a 已经加载并执行好
seajs.use('./b');
preload 配置不能放在模块文件里面:
define(function(require,exports) {
// 此处执行时,不能保证模块 a 已经加载并执行好
});
debug
Boolean
值为true时,加载器不会删除动态插入的 script 标签。插件也可以根据debug配置,来决策 log 等信息的输出。
base
String
Sea.js 在解析顶级标识时,会相对 base 路径来解析。
注意:一般请不要配置 base 路径,把 sea.js 放在合适的路径往往更简单一致。
charsetString | Function
获取模块文件时,
<script type="text/javascript">
//配置Seajs
seajs.config({
alias: {
//顶级标识,基于 base 路径
'actjs': 'actjs/core/0.0.7/core.js',// => http://
'position': 'actjs/util/0.0.2/position.js'
}
});
seajs.config({
alias: {
//普通路径,相对于当前页面
'affix': '../../actjs/assets/widget/src/widget-affix.js',//相对标识,相对于当前页面
'init': './src/init.js'
}
});