最新消息:本站所有跳转向bbs.ykit.cn的附件将全面停止,附件已转移到https://www.qingsj.com

NProgress.js-页面加载进度条

网页相关 有客 702浏览

NProgress.js提供页面加载进度条效果,当页面打开加载时,在页面顶部会出现进度条加载动画。NProgress.js是轻量级的进度条组件,使用简便,可以很方便集成到单页面应用中。

安装

使用npm安装

$ npm install --save nprogress

或者直接引用 nprogress.js 和nprogress.css 文件到你的页面中。

<script src='nprogress.js'></script> 
<link rel='stylesheet' href='nprogress.css'/>

用法

只需要调用start() 和 done()来控制进度条

NProgress.start();  // 开始加载 
NProgress.done();  // 加载完成

NProgress还提供了其他几个方法,如设置百分比,调用 .set(n)来控制进度,其中n的取值范围为0-1。调用 .inc()产生一个随机增量。通过传递 true 参数给done(),使进度条满格,强制完成。

NProgress.set(0.0);     // Sorta same as .start() 
NProgress.set(0.4); 
NProgress.set(1.0);     // Sorta same as .done() 
 
NProgress.inc(); // 递增 
NProgress.done(true);  // 强制完成

实际使用中,我们一般在Ajax或者Pjax加载时,调用NProgress。你可以在jQuery提供的Ajax,或者使用Pjax,或者在其他框架如Vue.js中都可以很好的使用NProgress。

这里我们示例演示使用Ajax方法请求远程数据,然后调用进度条加载的过程。

$('#loading').on('click', function(event) { 
    event.preventDefault(); 
    NProgress.start(); 
    $.get('data.php', function(data) { 
        $('#msg').html(data); 
        NProgress.done(); 
    }); 
});

以上代码,当点击按钮#loading时,会调用NProgress.start()开始进度条加载动画,并发送$.get请求远程数据,直到返回数据后,NProgress.done()结束加载动画。注意代码使用了jQuery库,所以你应该先加载jQuery的最新库文件。

这里为了让效果更逼真,我特意将data.php中的代码设置延迟2miao才响应返回数据。当然实际开发中是真实的后端代码执行。

<?php  
// data.php 
sleep(2); 
echo '返回数据:ok';

参数配置

minimum

设置开始时最低百分比,默认是0.08。

NProgress.configure({ minimum: 0.1 });

template

改变进度条的HTML结构。为了保证进度条正常工作,需要一个包含role=’bar’ 属性的元素。

NProgress.configure({ 
  template: "<div class='....'>...</div>" 
});

ease和speed

ease可传递CSS3缓冲动画字符串(如ease、linear、ease-in、ease-out、ease-in-out、cubic-bezier)。speed为动画速度(默认200,单位ms)。

NProgress.configure({ easing: 'ease', speed: 500 });

trickle

是否显示进度条,默认:true

NProgress.configure({ trickle: false });

trickleSpeed

设置每次进度条步进速度(ms)。

NProgress.configure({ trickleSpeed: 200 });

showSpinner

是否显示环形进度动画,默认true。

NProgress.configure({ showSpinner: false });

parent

指定改变的父容器,默认body。

NProgress.configure({ parent: '#container' });

当然,你也可以修改nprogress.css以达到你想要的进度条外观,比如改变进度条背景颜色、高度等等。NProgress项

项目地址:https://github.com/rstacruz/nprogress/

转载请注明:有客帮 » NProgress.js-页面加载进度条