requirejs中文API帮助文档推荐 原创 收藏

文章标签: 帮助手册
  • :
  • 03-25 12:11
  • :
  • 33次
  • :
  • 0条
  • 3赞

简介requirejs的中文手册,是站长参考多个网站整理而来的,结合了各个网站的精华,并加入了站长自己编写的一些对应实例。l

站长想到网上找个完美的关于requirejs插件的API手册,但是用了很大的功夫下载下来几个不同格式的手册,发现里面的内容都是“很不负责任”的网上复制粘贴过来的,最后站长自己就放弃了,干脆自己来总结一个中文帮助手册吧,参考了几个网站的内容,站长自己整理了一番,并准备了几个对应的实例,把和requirejs插件相关的各个知识点总结整理一下,分享给大家。

requirejs插件里共有三个函数:requirejsrequiredefine,并且requirejs和require是等价的,所以其实requirejs插件为我们提供的也就是两个函数:requiredefine

require是用来引用模块,define是用来定义模块,另外我们需要学习的就是require.config,也就是require的配置项,require.config也是rquirejs插件的重点和难点。

下面是一个非常基础的requirejs插件的入门实例:

RequireJS插件应用到自己的网页中的新手入门实例


通过上面这个入门的实例,我们应该能看到,require是非常简单的,语法结构如下:

require(['模块A','模块B'],function('模块A对应引用名','模块B对应引用名'){});

需要注意的:

  1. 引用模块时,即使只引用一个模块,也需要用中括号括起来,也就是中括号是不能省略的;

  2. '模块A'可以是我们在config里定义好的模块名,也可以是直接的路径,路径可以直接是外网的路径;

下面我们要说的是requirejs插件中的重点,require.config,首先我们来看require.config在使用时的基本结构:

require.config({  
    baseUrl: "/Inc/JS",  
    paths: {  
        "jquery": "jquery.min"  
    },  
    waitSeconds: 15  
 });

require.config里常用的就是上面这三个参数,baseUrlpathswaitSeconds,另外还有一个非常重要的参数:shim,这个参数是用来配置那些不符合AMD规范的js,站长会单独写一篇文章来介绍它,下面站长来给大家介绍require.config里的所有配置项:

  1. baseUrl:根目录,设置了根目录后,paths选项里的各个配置就不需要写同样的路径了,只用写相对于这个baseUrl的相对路径就行了;如果不设置baseUrl,那么就会把require.js这个源文件所在的目录当成根目录,但如果我们在加载requirejs源文件时,使用了data-main属性,那么data-main属性里的路径则会作为根目录。

  2. paths:配置我们要用的插件或模块的地址和路径,需要注意的有三点:
    第一:路径结尾的文件名后缀,也就是“.js”不能写,
    第二:paths里的各个参数的值,是可以为数组的,这一点站长在上面的那个新手入门实例里有过介绍了,不再多说了。
    第三:一些“有主模块”的名字是不能乱写的,比如我们常用的jquery库,只能用jquery,不能用其它的名字。

  3. waitSeconds:这个很简单,就是加载各个插件时的等待时间,单位是秒,如果值为0则表示永远等待下去,不过期,默认值是7秒;

  4. shim:用来配置和定义一些非AMD规范的模块,共有三个参数:
    1>.deps:值为数组,指明该模块的依赖性。
    2>.exports:输出的变量名,表名外部调用时这个模块的名字,再说直白点,就是把非AMD规范的js文件里的一个变量,或者对象暴露出去,方便模块的引用。
    3>.init:和上面的exports含义一样,不过exports是暴露一个变量,而init可以暴露多个,具体的可以看下面的实例:

    PS:requirejs通过配置shim来调用非AMD规范JS的方法及在线实例演示

最后我们要说的就是requirejs插件里的define了,也就是定义模块,关于define,站长也会再单独开一篇文章来详细的介绍它。



您正在找的文章可能是:
热点文章
热点图文
最近更新
  • Copyright © aijquery.cn 爱jQuery-完全免费的jquery交流学习网站
  • 豫ICP备17037455号-1
  • 2018-11-15 14:43:28