JSLib是我们根据以往的开发工作,总结出来的一套JavaScript工具集。本意是规范内部开发接口,后来觉得这个项目可以单独出来尝试进行一些共享或开源的工作。所以我们正在重新整理JSLib代码,并逐步释放一些相对通用的功能,并会先把相应的调用方式、接口、示例等共享出来,供大家参考、学习使用。
JSLib的基本架构和使用方式类似JQuery,可以简单的理解为JSLib的基础是一个简版的JQuery(注:部分接口不一致,只是类似)。但也不要过于简单的理解成就是一个简版JQuery,因为我们后面会慢慢放出一些相对大一些的应用扩展,例如刚开发的tableCells,以及未来加入的tree、ctree、inputSelect、ajax、post等多个插件。
因为在调用JSLib时,默认使用$js进行调用,所以我们内部也把JSLib称为$js。也就是说,在本项目内JSLib与$js两个名称都是指本项目的JSLib库。
如果在学习过程中遇到任何问题或有什么想法,请发到 https://github.com/shanmin/jslib/issues 进行交流。如果提交issue不方便,也可以直接给我们发送邮件进行交流 Email: 0123@163.com 。
查看文档请前往: https://shanmin.github.io/jslib/
在使用$js时,一定要引用dist/jslib.min.js文件。
jslib.min.js文件的存放位置不做任何限定,可根据项目自身的需要把dist目录下jslib.min.js文件进行任意存放(其他分包文件如果使用了,建议与jslib.min.js放到同一目录,如果未放置同一目录则需要设置$js.PATH属性)。
因为本JSLib库比较大,所以当主文件大于1M时我们会考虑拆包的问题。通常,我们会按照不同功能进行拆包,例如与中文相关的操作,我们已经拆出一个jslib.zh.min.js的独立文件。在使用这类方法时,需要这个分包文件在jslib.min.js同目录下保存,但不需要手工进行引用,库会在调用时自动进行加载操作(按需加载)。
实际使用时,仅需要部署dist目录下文件即可。本项目中的其他文件仅做为JSLib文档及示例使用。
正常情况下JSLib版本号分为三部分:a.b.c。
如果a有变化,则表示整个库架构有所变化,对之前调用的兼容性会带来比较大的影响,升级时需要重新测试所有的接口调用。
如果b有变化,则表示部分接口有所变化,对之前调用的指定功能兼容性会带来一定影响,升级时需要重新测试升级接口的调用。
如果c有变化,则表示小幅度更改或新功能添加。一般来说不会对之前的调用造成实质影响。
需要注意的是JSLib的版本号规则与通常的版本号规则的差异,因为做为库类项目,接口兼容性比功能性更重要,所以JSLib的版本号是根据接口变化程度修改的。例如,我们在新增功能或接口时,一般只会更改此版本号c,而之前某个接口的参数或功能变更会修改版本号b,这点与通常意义上的版本号不一样。