Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kunukn/reading-position-indicator
Small mobile friendly reading position indicator library with no external dependencies
https://github.com/kunukn/reading-position-indicator
progress-bar
Last synced: 16 days ago
JSON representation
Small mobile friendly reading position indicator library with no external dependencies
- Host: GitHub
- URL: https://github.com/kunukn/reading-position-indicator
- Owner: kunukn
- License: mit
- Created: 2017-02-09T08:47:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T04:35:57.000Z (over 1 year ago)
- Last Synced: 2024-09-20T07:08:26.064Z (about 2 months ago)
- Topics: progress-bar
- Language: JavaScript
- Homepage:
- Size: 2.54 MB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# reading position indicator
Small mobile friendly reading position indicator library with no external dependencies.
# newer library
A newer library exists here.
https://github.com/kunukn/position-indicator
This is more flexible and easier to integrate with UI libraries like React, Vue and Angular.
# demo
* https://codepen.io/kunukn/full/zNJqEE (version 1.0.3+)
* https://codepen.io/kunukn/full/ayeMZN/ (version 2.0.0+)
# about
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 `` 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.
# browser support
 |  |  |  | 
--- | --- | --- | --- | --- |
IE 11 ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
# npm
https://www.npmjs.com/package/reading-position-indicator
# size
* js `~6kb`
* css `<1kb`
# test
Tested with latest Chrome, Safari, Firefox, Edge, IE10+, iOS7+, Android 4.3+
# usage
Check the **dist/index.html** for inspiration.
* Add reference to `rpi.bundle.js` and `rpi.bundle.css` in the html page
* Apply the markup structure
* Init the library with JS
### html structure
```html
...
...
...
new ReadingPositionIndicator().init();
```
### minimum markup required
```html
```
### configuration and usage example
```javascript
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
```
# development
* git clone the project or download it
* npm install
* npm start
* open a browser and go to localhost:3333
# build library into dist folder
* npm run build
# how does it work?
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.
# license
MIT License: http://opensource.org/licenses/MIT