Giter VIP home page Giter VIP logo

prognroll's Introduction

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.

prognroll's People

Contributors

mburakerman avatar

Watchers

vincent guo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.