Skip to content

A tiny, lightweight jQuery plugin that creates scroll progress bar on the page.

License

Notifications You must be signed in to change notification settings

touchX/prognroll

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PrognRoll

A tiny, lightweight jQuery plugin that creates scroll progress bar on the page

Install

Load jQuery and include PrognRoll file

<script src="jquery.js"></script>
<script src="src/prognroll.js"></script>
or use CDN
<link rel="stylesheet" href="https://code.jquery.com/jquery-3.1.1.min.js">
<link rel="stylesheet" href="https://cdn.rawgit.com/mburakerman/prognroll/master/src/prognroll.js">

Usage

To see scrolling progress on your page, you need to activate PrognRoll.

$(function() {
  $("body").prognroll();
});

Thats it! It's active now!

You can also customize the progress bar.These are default settings.

$(function() {
$("body").prognroll({
height:5,        //Progress bar height
color:"#50bcb6", //Progress bar background color
position:"top",  //Progress bar position can be "top" or "bottom"
custom:false     //If you make it true, you can add your custom div and see it's scroll progress on the page	
});
});

Examples

Use body

<body>
<!-- Content -->
</body>
$(function() {
  $("body").prognroll();
});

Quick body demo on CodePen

Use custom div

<div class="box">
<!-- Content -->
</div>
$(function() {
$(".box").prognroll({
custom:true
});
});

Quick custom div demo on CodePen

Size

1.99 kb

1 kb minified

License

Licensed under the MIT License.

About

A tiny, lightweight jQuery plugin that creates scroll progress bar on the page.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 69.8%
  • CSS 23.6%
  • JavaScript 6.6%