reading-position-indicator
Advanced tools
Small mobile friendly reading position indicator library with no external dependencies.
A position indicator at the top of the page to visually display how far you have scrolled on a webpage.
Build with focus on simplicity, performance and a11y. Using transform translate for best performance. rAF for throttling scroll update and debounce for resize update.
Aria tags are used to support screen readers.
The progress element <progress> has not been used because the code gets messy with vendor prefixes and removing the default styles that comes with each browser. It gets even messier when fallback elements are added inside the progress element to support older browsers.
 |  |  |  |  |
|---|---|---|---|---|
| IE 10+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
https://www.npmjs.com/package/reading-position-indicator
~6kb<1kbTested with latest Chrome, Safari, Firefox, Edge, IE10+, iOS7+, Android 4.3+
Check the dist/index.html for inspiration.
rpi.bundle.js and rpi.bundle.css in the html page<head>
...
<link rel="stylesheet" href="rpi.bundle.css">
...
</head>
<body>
<!-- library markup -->
<div class="rpi-progress-bar"
role="progressbar"
aria-valuemin="0"
aria-valuemax="100"
aria-valuenow="0">
<div class="rpi-progress-bar__position" aria-hidden="true"></div>
<div class="rpi-progress-bar__percentage"></div>
</div>
<!-- end library markup -->
...
<script src="rpi.bundle.js"></script> <!-- library -->
<script>new ReadingPositionIndicator().init();</script> <!-- usage -->
</body>
<div class="rpi-progress-bar">
<div class="rpi-progress-bar__position"></div>
<div class="rpi-progress-bar__percentage"></div>
</div>
var rpi;
setTimeout(function waitUntilDomIsReadyLoadingCustomFontsMightOffsetThis() {
rpi = new ReadingPositionIndicator({
rpiArea: '[data-rpi-area]', /* optional, query selector to an element */
progressBar: { /* optional */
show: true, /* default true */
color: 'rgba(0, 120, 120, .5)', /* default from css */
},
percentage: { /* optional */
show: true, /* default false */
displayBeforeScroll: false, /* default false */
opacity: .3, /* default from css */
color: '#000', /* default from css */
},
}).init();
}, 200); // wait until DOM has fully rendered the article to get the calculations correct
// rpi.destroy(); // use when to be removed
// rpi.update(); // optional force update, example: DOM was updated and need to refresh the indicator
It calculate heights for viewport, document and current scroll position. If rpiArea is used then it also uses getBoundingClientRect method to calculate dom element dimension. DOM updates are only applied if data has changed since last time. The calculation is updated on scroll and resize event and the information is updated to the DOM.
MIT License: http://opensource.org/licenses/MIT
2.0.3
FAQs
Reading position indicator on a webpage
The npm package reading-position-indicator receives a total of 46 weekly downloads. As such, reading-position-indicator popularity was classified as not popular.
We found that reading-position-indicator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.