diff --git a/README_CN.md b/README_CN.md index 3307676..b5c5205 100644 --- a/README_CN.md +++ b/README_CN.md @@ -5,11 +5,11 @@ # 概述 domloader是一个模版加载小工具,帮助你简单地构建前后端分离的web前端程序。 无需太多复杂的学习成本,看完本页即可上手,甚至可以立即应用到你现有的项目。 -你可以像使用其他混合html的后端语言一样,对你的前端项目文件进行模块化处理。 +你可以像使用其他混合 html 的后端语言一样,对你的前端项目文件进行模块化处理。 比如将页头和页脚与页面主体内容单独抽取出来,形成模块,批量应用到其他类似页面。 另外,domloader在加载时会显示一个进度界面。 -进度界面会遮盖加载过程, 这类似于iOS上app启动界面机制。 +进度界面会遮盖加载过程, 这类似于 iOS 上 app 启动界面机制。 因此可以缓解因网速慢,或者页面资源较多而导致显示不完全问题。 加载进度是真实的加载进度,并非模拟。 @@ -30,43 +30,47 @@ domloader是一个模版加载小工具,帮助你简单地构建前后端分

+# 升级版本 +domloader 由一个 js 文件和一个 css 文件组成,合计约 12 kb。 +每次升级版本,您只需要将最新版本的两个文件覆盖即可。 + # 队列加载 -为了确保页面功能不混乱,domloader会队列加载预设的内容(浏览器通常是并发加载页面资源)。 +为了确保页面功能不混乱,domloader 会队列加载预设的内容(浏览器通常是并发加载页面资源)。 这种方式在首次访问时可能会稍微降低页面的加载速度,而在之后瞬间完成。 计划在后期优化加载速度以及动画效果。 # 包含 -domloader的核心功能需要jQuery支持才能实现,因此在使用domloader时请务必加载jQuery。 +domloader 的核心功能需要 jQuery 支持才能实现,因此在使用 domloader 时请务必加载 jQuery 。 # 用法 -## 首先,建议先加载jQuery。 +## 首先,建议先加载 jQuery 。 ```html ```` -## 然后,加载domloader。 +## 然后,加载 domloader 。 ```html ```` -通常建议在页面的head部分加入domload的执行代码,以确保domloader可以优先运行。 +通常建议在页面的head部分加入 domloader 的执行代码,以确保 domloader 可以优先运行。 domloader会在页面准备就绪时自动执行设定的加载指令。 ```javascript domloader.init() ``` -## 加载一个HTML块 +## 加载一个 HTML 块 ```javascript domloader.html(dom,path); -//参数dom指的是domloader该向哪个ID注入html块的内容。这是使用了jQuery的选择器。 -//参数path指的是domloader从哪里获取html块。 +//参数 dom 指的是 domloader 该向哪个 ID 注入 html 块的内容。这是使用了 jQuery 的选择器。 +//参数 path 指的是 domloader 从哪里获取 html 块。 ``` 举一个例子 -下面的这段代码,会在页面就绪时,由domloader下载header.html的内容,并替换掉id="head"的区块。 +下面的这段代码,会在页面就绪时,由 domloader 下载 header.html 的内容,并替换掉 d="head" 的区块。 ```html @@ -85,7 +89,7 @@ domloader.html(dom,path); ``` ## 预加载文件 -预加载功能优先于所有资源文件,会在页面加载后立即执行预加载功能,将代码插入到head后方。 +预加载功能优先于所有资源文件,会在页面加载后立即执行预加载功能,将代码插入到 head 后方。 所有预加载资源不会受到浏览器缓存的影响,均为无缓存(重点)。 因此预加载功能通常用来加载一些配置信息,比如定义了 version 参数的配置文件。 ```javascript @@ -93,8 +97,8 @@ domloader.preload(path); ``` ## 加载CSS和JS文件 -对于CSS文件,domloader会按顺序将其插入到head的尾部,以外部样式表的方式。 -而对于JS文件,domloader会按顺序下载好JS的内容后,以script标签内嵌的方式,将js内容插入到body的尾部。 +对于 CSS 文件,domloader 会按顺序将其插入到 head 的尾部,以外部样式表的方式。 +而对于 JS 文件,domloader 会按顺序下载好 JS 的内容后,以 script 标签内嵌的方式,将 js 内容插入到 body 的尾部。 ```javascript domloader.css(path); domloader.js(path); @@ -128,7 +132,7 @@ domloader.version = 'v1.0'; ## 设置加载完成后的回调操作 有一些操作必须要在所有资源加载完成之后进行。 -onload方法允许你设置一系列回调,将会在domloader加载完所有资源文件后启动这个回调。 +onload 方法允许你设置一系列回调,将会在 domloader 加载完所有资源文件后启动这个回调。 ```javascript domloader.onload( function(){ xxx.xxx(); } @@ -143,11 +147,18 @@ domloader.icon = '/yourlogo.png'; ## 控制加载页面的进度条时间 此参数控制进度条动画总时间,即如果所有文件都为就绪状态,进度条跑完的时间。 -默认值为500ms +默认值为 500 ms ```javascript domloader.animation_time = 500; ``` +## 关闭进度条 +此参数可以直接关闭进度条。 +默认值为 true +```javascript +domloader.animation = false; +``` + ## 显示控制台调试信息 domloader.debug 控制是否在控制台输出加载调试信息。默认是打开的,你可以设置为false来屏蔽这些信息。 ```javascript diff --git a/README_EN.md b/README_EN.md index 9316656..e13c1cd 100644 --- a/README_EN.md +++ b/README_EN.md @@ -30,6 +30,10 @@ Features:

+# Upgrade +The domloader consists of domloader.js and domloader.css , totaling about 12 kb. +Each time you upgrade your version, you only need to overwrite the two files in the latest version. + # Queue loading In order to ensure that the page function is not confusing, the domloader will queue the preset content (the browser usually loads the page resources concurrently). This method may slightly slow down the page loading time on the first visit, and then complete it in a short time. @@ -154,6 +158,13 @@ Default : 500ms domloader.animation_time = 500; ``` +## Disable animation +The progress bar is not displayed when the resource is loading. +Default : true +```javascript +domloader.animation = true; +``` + ## Display console debugging information Domloader.debug Controls whether debugging information is loaded in the console output. The default is on, you can set this to false to block this information.